Interface CfnConfigurationProfileMixinProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnConfigurationProfileMixinProps.Jsii$Proxy
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cfnpropertymixins.services.appconfig.*;
CfnConfigurationProfileMixinProps cfnConfigurationProfileMixinProps = CfnConfigurationProfileMixinProps.builder()
.applicationId("applicationId")
.deletionProtectionCheck("deletionProtectionCheck")
.description("description")
.kmsKeyIdentifier("kmsKeyIdentifier")
.locationUri("locationUri")
.name("name")
.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 classA builder forCfnConfigurationProfileMixinPropsstatic final classAn implementation forCfnConfigurationProfileMixinProps -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe application ID.default StringA parameter to configure deletion protection.default StringA description of the configuration profile.default StringThe AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.default StringA URI to locate the configuration.default StringgetName()A name for the configuration profile.default ObjectThe ARN of an IAM role with permission to access the configuration at the specifiedLocationUri.getTags()Metadata to assign to the configuration profile.default StringgetType()The type of configurations contained in the profile.default ObjectA list of methods for validating the configuration.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationId
The application ID.Returns union: either
StringorIApplicationRef- See Also:
-
getDeletionProtectionCheck
A parameter to configure deletion protection.Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or GetConfiguration for the configuration profile during the specified interval.
This parameter supports the following values:
BYPASS: Instructs AWS AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it.APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level.APPLYalso forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks.ACCOUNT_DEFAULT: The default setting, which instructs AWS AppConfig to implement the deletion protection value specified in theUpdateAccountSettingsAPI.
- 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:
-
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://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).
- See Also:
- For the AWS AppConfig hosted configuration store and for feature flags, specify
-
getName
A name for the configuration profile.- 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 AWS CodePipeline or 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 flagsandfreeformconfigurations. 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.FeatureFlagsAWS.Freeform- See Also:
-
getValidators
A list of methods for validating the configuration.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnConfigurationProfilePropsMixin.ValidatorsProperty>- See Also:
-
builder
-