Class CfnConfigurationProfileProps.Builder
java.lang.Object
software.amazon.awscdk.services.appconfig.CfnConfigurationProfileProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnConfigurationProfileProps>
- Enclosing interface:
CfnConfigurationProfileProps
@Stability(Stable)
public static final class CfnConfigurationProfileProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnConfigurationProfileProps>
A builder for
CfnConfigurationProfileProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) Sets the value ofCfnConfigurationProfileProps.getApplicationId()
build()
Builds the configured instance.description
(String description) Sets the value ofCfnConfigurationProfileProps.getDescription()
kmsKeyIdentifier
(String kmsKeyIdentifier) Sets the value ofCfnConfigurationProfileProps.getKmsKeyIdentifier()
locationUri
(String locationUri) Sets the value ofCfnConfigurationProfileProps.getLocationUri()
Sets the value ofCfnConfigurationProfileProps.getName()
retrievalRoleArn
(String retrievalRoleArn) Sets the value ofCfnConfigurationProfileProps.getRetrievalRoleArn()
Sets the value ofCfnConfigurationProfileProps.getTags()
Sets the value ofCfnConfigurationProfileProps.getType()
validators
(List<? extends Object> validators) Sets the value ofCfnConfigurationProfileProps.getValidators()
validators
(IResolvable validators) Sets the value ofCfnConfigurationProfileProps.getValidators()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
applicationId
Sets the value ofCfnConfigurationProfileProps.getApplicationId()
- Parameters:
applicationId
- The application ID. This parameter is required.- Returns:
this
-
locationUri
Sets the value ofCfnConfigurationProfileProps.getLocationUri()
- Parameters:
locationUri
- A URI to locate the configuration. You can specify the following:. This parameter is required.- For the AWS AppConfig hosted configuration store and for feature flags, specify
hosted
. - For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format
ssm-parameter://<parameter name>
or the ARN. - For an AWS CodePipeline pipeline, specify the URI in the following format:
codepipeline
://. - For an AWS Secrets Manager secret, specify the URI in the following format:
secretsmanager
://. - For an Amazon S3 object, specify the URI in the following format:
s3://<bucket>/<objectKey>
. Here is an example:s3://amzn-s3-demo-bucket/my-app/us-east-1/my-config.json
- For an SSM document, specify either the document name in the format
ssm-document://<document name>
or the Amazon Resource Name (ARN).
- For the AWS AppConfig hosted configuration store and for feature flags, specify
- Returns:
this
-
name
Sets the value ofCfnConfigurationProfileProps.getName()
- Parameters:
name
- A name for the configuration profile. This parameter is required.- Returns:
this
-
description
Sets the value ofCfnConfigurationProfileProps.getDescription()
- Parameters:
description
- A description of the configuration profile.- Returns:
this
-
kmsKeyIdentifier
@Stability(Stable) public CfnConfigurationProfileProps.Builder kmsKeyIdentifier(String kmsKeyIdentifier) Sets the value ofCfnConfigurationProfileProps.getKmsKeyIdentifier()
- Parameters:
kmsKeyIdentifier
- The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.- Returns:
this
-
retrievalRoleArn
@Stability(Stable) public CfnConfigurationProfileProps.Builder retrievalRoleArn(String retrievalRoleArn) Sets the value ofCfnConfigurationProfileProps.getRetrievalRoleArn()
- Parameters:
retrievalRoleArn
- The ARN of an IAM role with permission to access the configuration at the specifiedLocationUri
.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.
- Returns:
this
-
tags
Sets the value ofCfnConfigurationProfileProps.getTags()
- Parameters:
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.- Returns:
this
-
type
Sets the value ofCfnConfigurationProfileProps.getType()
- Parameters:
type
- The type of configurations contained in the profile. AWS AppConfig supportsfeature flags
andfreeform
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 forType
:AWS.AppConfig.FeatureFlags
AWS.Freeform
- Returns:
this
-
validators
Sets the value ofCfnConfigurationProfileProps.getValidators()
- Parameters:
validators
- A list of methods for validating the configuration.- Returns:
this
-
validators
@Stability(Stable) public CfnConfigurationProfileProps.Builder validators(List<? extends Object> validators) Sets the value ofCfnConfigurationProfileProps.getValidators()
- Parameters:
validators
- A list of methods for validating the configuration.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnConfigurationProfileProps>
- Returns:
- a new instance of
CfnConfigurationProfileProps
- Throws:
NullPointerException
- if any required attribute was not provided
-