Interface CfnConfigurationProfileProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConfigurationProfileProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:10.773Z")
@Stability(Stable)
public interface CfnConfigurationProfileProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnConfigurationProfile
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.appconfig.*; CfnConfigurationProfileProps cfnConfigurationProfileProps = CfnConfigurationProfileProps.builder() .applicationId("applicationId") .locationUri("locationUri") .name("name") // the properties below are optional .description("description") .kmsKeyIdentifier("kmsKeyIdentifier") .retrievalRoleArn("retrievalRoleArn") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .type("type") .validators(List.of(ValidatorsProperty.builder() .content("content") .type("type") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnConfigurationProfileProps
static final class
An implementation forCfnConfigurationProfileProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The application ID.default String
A description of the configuration profile.default String
The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.A URI to locate the configuration.getName()
A name for the configuration profile.default String
The ARN of an IAM role with permission to access the configuration at the specifiedLocationUri
.getTags()
Metadata to assign to the configuration profile.default String
getType()
The type of configurations contained in the profile.default Object
A list of methods for validating the configuration.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationId
The application ID.- See Also:
-
getLocationUri
A URI to locate the configuration. You can specify the following:.- 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://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).
- See Also:
- For the AWS AppConfig hosted configuration store and for feature flags, specify
-
getName
A name for the configuration profile.- See Also:
-
getDescription
A description of the configuration profile.- See Also:
-
getKmsKeyIdentifier
The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.- See Also:
-
getRetrievalRoleArn
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.
- See Also:
-
getTags
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.
- See Also:
-
getType
The type of configurations contained in the profile.AWS 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
- See Also:
-
getValidators
A list of methods for validating the configuration.- See Also:
-
builder
-