Interface CreateConfigurationProfileRequest.Builder
- All Superinterfaces:
AppConfigRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateConfigurationProfileRequest.Builder,
,CreateConfigurationProfileRequest> SdkBuilder<CreateConfigurationProfileRequest.Builder,
,CreateConfigurationProfileRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateConfigurationProfileRequest
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The application ID.description
(String description) A description of the configuration profile.kmsKeyIdentifier
(String kmsKeyIdentifier) The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store.locationUri
(String locationUri) A URI to locate the configuration.A name for the configuration profile.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.retrievalRoleArn
(String retrievalRoleArn) The ARN of an IAM role with permission to access the configuration at the specifiedLocationUri
.Metadata to assign to the configuration profile.The type of configurations contained in the profile.validators
(Collection<Validator> validators) A list of methods for validating the configuration.validators
(Consumer<Validator.Builder>... validators) A list of methods for validating the configuration.validators
(Validator... validators) A list of methods for validating the configuration.Methods inherited from interface software.amazon.awssdk.services.appconfig.model.AppConfigRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
applicationId
The application ID.
- Parameters:
applicationId
- The application ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
A name for the configuration profile.
- Parameters:
name
- A name for the configuration profile.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
A description of the configuration profile.
- Parameters:
description
- A description of the configuration profile.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
locationUri
A URI to locate the configuration. You can specify the following:
-
For the AppConfig hosted configuration store and for feature flags, specify
hosted
. -
For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format
ssm-parameter://<parameter name>
or the ARN. -
For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format:
codepipeline
://<pipeline name>. -
For an Secrets Manager secret, specify the URI in the following format:
secretsmanager
://<secret name>. -
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
-
For an SSM document, specify either the document name in the format
ssm-document://<document name>
or the Amazon Resource Name (ARN).
- Parameters:
locationUri
- A URI to locate the configuration. You can specify the following:-
For the AppConfig hosted configuration store and for feature flags, specify
hosted
. -
For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format
ssm-parameter://<parameter name>
or the ARN. -
For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format:
codepipeline
://<pipeline name>. -
For an Secrets Manager secret, specify the URI in the following format:
secretsmanager
://<secret name>. -
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
-
For an SSM document, specify either the document name in the format
ssm-document://<document name>
or the Amazon Resource Name (ARN).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 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 specifiedLocationUri
.A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
validators
A list of methods for validating the configuration.
- Parameters:
validators
- A list of methods for validating the configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
validators
A list of methods for validating the configuration.
- Parameters:
validators
- A list of methods for validating the configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
validators
A list of methods for validating the configuration.
This is a convenience method that creates an instance of theValidator.Builder
avoiding the need to create one manually viaValidator.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tovalidators(List<Validator>)
.- Parameters:
validators
- a consumer that will call methods onValidator.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Metadata to assign to the configuration profile. Tags help organize and categorize your 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. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
type
The type of configurations contained in the profile. AppConfig supports
feature 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
- Parameters:
type
- The type of configurations contained in the profile. 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:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyIdentifier
The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for
hosted
configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.- Parameters:
kmsKeyIdentifier
- The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used forhosted
configuration types. The identifier can be an KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateConfigurationProfileRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateConfigurationProfileRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-