software.amazon.awscdk.services.appconfig

Class CfnConfigurationProfile.Builder

java.lang.Object

software.amazon.awscdk.services.appconfig.CfnConfigurationProfile.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnConfigurationProfile>

Enclosing class:

CfnConfigurationProfile

@Stability(value=Stable)
public static final class CfnConfigurationProfile.Builder
extends Object
implements software.amazon.jsii.Builder<CfnConfigurationProfile>

A fluent builder for CfnConfigurationProfile.

Method Summary

Modifier and Type	Method and Description
CfnConfigurationProfile.Builder	applicationId(String applicationId) The application ID.
CfnConfigurationProfile	build()
static CfnConfigurationProfile.Builder	create(software.constructs.Construct scope, String id)
CfnConfigurationProfile.Builder	description(String description) A description of the configuration profile.
CfnConfigurationProfile.Builder	locationUri(String locationUri) A URI to locate the configuration.
CfnConfigurationProfile.Builder	name(String name) A name for the configuration profile.
CfnConfigurationProfile.Builder	retrievalRoleArn(String retrievalRoleArn) The ARN of an IAM role with permission to access the configuration at the specified `LocationUri` .
CfnConfigurationProfile.Builder	tags(List<? extends CfnConfigurationProfile.TagsProperty> tags) Metadata to assign to the configuration profile.
CfnConfigurationProfile.Builder	type(String type) The type of configurations contained in the profile.
CfnConfigurationProfile.Builder	validators(IResolvable validators) A list of methods for validating the configuration.
CfnConfigurationProfile.Builder	validators(List<? extends Object> validators) A list of methods for validating the configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static CfnConfigurationProfile.Builder create(software.constructs.Construct scope,
                                                                              String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnConfigurationProfile.TagsProperty.Builder.

applicationId

@Stability(value=Stable)
public CfnConfigurationProfile.Builder applicationId(String applicationId)

The application ID.

Parameters:

applicationId - The application ID. This parameter is required.

Returns:

this

locationUri

@Stability(value=Stable)
public CfnConfigurationProfile.Builder locationUri(String locationUri)

A URI to locate the configuration.

You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store and for feature flags, specify hosted . For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

Parameters:

locationUri - A URI to locate the configuration. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnConfigurationProfile.Builder name(String name)

A name for the configuration profile.

Parameters:

name - A name for the configuration profile. This parameter is required.

Returns:

this

description

@Stability(value=Stable)
public CfnConfigurationProfile.Builder description(String description)

A description of the configuration profile.

Parameters:

description - A description of the configuration profile. This parameter is required.

Returns:

this

retrievalRoleArn

@Stability(value=Stable)
public CfnConfigurationProfile.Builder retrievalRoleArn(String retrievalRoleArn)

The ARN of an IAM role with permission to access the configuration at the specified `LocationUri` .

A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.

Parameters:

retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at the specified `LocationUri` . This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnConfigurationProfile.Builder tags(List<? extends CfnConfigurationProfile.TagsProperty> tags)

Metadata to assign to the configuration profile.

Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Parameters:

tags - Metadata to assign to the configuration profile. This parameter is required.

Returns:

this

type

@Stability(value=Stable)
public CfnConfigurationProfile.Builder type(String type)

The type of configurations contained in the profile.

AWS AppConfig supports feature flags and freeform configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for Type :

AWS.AppConfig.FeatureFlags

AWS.Freeform

Parameters:

type - The type of configurations contained in the profile. This parameter is required.

Returns:

this

validators

@Stability(value=Stable)
public CfnConfigurationProfile.Builder validators(IResolvable validators)

A list of methods for validating the configuration.

Parameters:

validators - A list of methods for validating the configuration. This parameter is required.

Returns:

this

validators

@Stability(value=Stable)
public CfnConfigurationProfile.Builder validators(List<? extends Object> validators)

A list of methods for validating the configuration.

Parameters:

validators - A list of methods for validating the configuration. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnConfigurationProfile build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnConfigurationProfile>