CfnConfigurationProfile L1 construct
The AWS::AppConfig::ConfigurationProfile resource creates a configuration profile that enables AWS AppConfig to access the configuration source.
Valid configuration sources include AWS Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 . A configuration profile includes the following information.
- The Uri location of the configuration data.
- The AWS Identity and Access Management ( IAM ) role that provides access to the configuration data.
- A validator for the configuration data. Available validators include either a JSON Schema or the Amazon Resource Name (ARN) of an AWS Lambda function.
AWS AppConfig requires that you create resources and deploy a configuration in the following order:
- Create an application
- Create an environment
- Create a configuration profile
- Choose a pre-defined deployment strategy or create your own
- Deploy the configuration
For more information, see AWS AppConfig in the AWS AppConfig User Guide .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appconfig as appconfig } from 'aws-cdk-lib';
const cfnConfigurationProfile = new appconfig.CfnConfigurationProfile(this, 'MyCfnConfigurationProfile', {
applicationId: 'applicationId',
locationUri: 'locationUri',
name: 'name',
// the properties below are optional
deletionProtectionCheck: 'deletionProtectionCheck',
description: 'description',
kmsKeyIdentifier: 'kmsKeyIdentifier',
retrievalRoleArn: 'retrievalRoleArn',
tags: [{
key: 'key',
value: 'value',
}],
type: 'type',
validators: [{
content: 'content',
type: 'type',
}],
});
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_appconfig as appconfig
cfn_configuration_profile = appconfig.CfnConfigurationProfile(self, "MyCfnConfigurationProfile",
application_id="applicationId",
location_uri="locationUri",
name="name",
# the properties below are optional
deletion_protection_check="deletionProtectionCheck",
description="description",
kms_key_identifier="kmsKeyIdentifier",
retrieval_role_arn="retrievalRoleArn",
tags=[CfnTag(
key="key",
value="value"
)],
type="type",
validators=[appconfig.CfnConfigurationProfile.ValidatorsProperty(
content="content",
type="type"
)]
)
// 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.*;
CfnConfigurationProfile cfnConfigurationProfile = CfnConfigurationProfile.Builder.create(this, "MyCfnConfigurationProfile")
.applicationId("applicationId")
.locationUri("locationUri")
.name("name")
// the properties below are optional
.deletionProtectionCheck("deletionProtectionCheck")
.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();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppConfig;
var cfnConfigurationProfile = new CfnConfigurationProfile(this, "MyCfnConfigurationProfile", new CfnConfigurationProfileProps {
ApplicationId = "applicationId",
LocationUri = "locationUri",
Name = "name",
// the properties below are optional
DeletionProtectionCheck = "deletionProtectionCheck",
Description = "description",
KmsKeyIdentifier = "kmsKeyIdentifier",
RetrievalRoleArn = "retrievalRoleArn",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type",
Validators = new [] { new ValidatorsProperty {
Content = "content",
Type = "type"
} }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnConfigurationProfile := awscdk.Aws_appconfig.NewCfnConfigurationProfile(this, jsii.String("MyCfnConfigurationProfile"), &CfnConfigurationProfileProps{
ApplicationId: jsii.String("applicationId"),
LocationUri: jsii.String("locationUri"),
Name: jsii.String("name"),
// the properties below are optional
DeletionProtectionCheck: jsii.String("deletionProtectionCheck"),
Description: jsii.String("description"),
KmsKeyIdentifier: jsii.String("kmsKeyIdentifier"),
RetrievalRoleArn: jsii.String("retrievalRoleArn"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Type: jsii.String("type"),
Validators: []interface{}{
&ValidatorsProperty{
Content: jsii.String("content"),
Type: jsii.String("type"),
},
},
})
Initializer
new CfnConfigurationProfile(scope: Construct, id: string, props: CfnConfigurationProfileProps)
CfnConfigurationProfile(scope: Construct, id: str, props: CfnConfigurationProfileProps)
new CfnConfigurationProfile(Construct scope, String id, CfnConfigurationProfileProps props)
new CfnConfigurationProfile(Construct scope, string id, CfnConfigurationProfileProps props)
NewCfnConfigurationProfile(Scope Construct, Id *string, Props CfnConfigurationProfileProps)
Construct Props
applicationIdstring | IApplicationRefapplication_idtyping.Union[str, IApplicationRef]applicationIdStringApplicationIdstringApplicationIdinterface{}required#deletionProtectionCheckoptionalstringdeletion_protection_checkoptionalstrdeletionProtectionCheckoptionalStringDeletionProtectionCheckoptionalstringDeletionProtectionCheckoptional*string#notes
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.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#kmsKeyIdentifieroptionalstringkms_key_identifieroptionalstrkmsKeyIdentifieroptionalStringKmsKeyIdentifieroptionalstringKmsKeyIdentifieroptional*string#notes
- 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😕/<pipeline name>. - For an AWS 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://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).
retrievalRoleArnoptionalstring | IRoleRefretrieval_role_arnoptionaltyping.Union[str, IRoleRef]retrievalRoleArnoptionalStringRetrievalRoleArnoptionalstringRetrievalRoleArnoptionalinterface{}#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.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
notes
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
validatorsoptionalIResolvable | IResolvable | CfnConfigurationProfile.ValidatorsProperty[]validatorsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ValidatorsProperty]]]validatorsoptionalIResolvableValidatorsoptionalIResolvableValidatorsoptionalinterface{}#Properties
attrConfigurationProfileIdstringattr_configuration_profile_idstrattrConfigurationProfileIdStringAttrConfigurationProfileIdstringAttrConfigurationProfileId*string#This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS key for that particular service.
cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManager#CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#configurationProfileRefConfigurationProfileReferenceconfiguration_profile_refConfigurationProfileReferenceconfigurationProfileRefConfigurationProfileReferenceConfigurationProfileRefConfigurationProfileReferenceConfigurationProfileRefConfigurationProfileReference#creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#deletionProtectionCheckmay be undefinedstringdeletion_protection_checkmay be undefinedstrdeletionProtectionCheckmay be undefinedStringDeletionProtectionCheckmay be undefinedstringDeletionProtectionCheckmay be undefined*string#descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#kmsKeyIdentifiermay be undefinedstringkms_key_identifiermay be undefinedstrkmsKeyIdentifiermay be undefinedStringKmsKeyIdentifiermay be undefinedstringKmsKeyIdentifiermay be undefined*string#You can specify the following:.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId).
If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).
retrievalRoleArnmay be undefinedstringretrieval_role_arnmay be undefinedstrretrievalRoleArnmay be undefinedStringRetrievalRoleArnmay be undefinedstringRetrievalRoleArnmay be undefined*string#CfnElements must be defined within a stack scope (directly or indirectly).
tagsmay be undefinedCfnTag[]tagsmay be undefinedtyping.List[CfnTag]tagsmay be undefinedList<CfnTag>Tagsmay be undefinedCfnTag[]Tagsmay be undefined*[]CfnTag#typemay be undefinedstringtypemay be undefinedstrtypemay be undefinedStringTypemay be undefinedstringTypemay be undefined*string#validatorsmay be undefinedIResolvable | IResolvable | CfnConfigurationProfile.ValidatorsProperty[]validatorsmay be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ValidatorsProperty]]]validatorsmay be undefinedIResolvableValidatorsmay be undefinedIResolvableValidatorsmay be undefinedinterface{}#Methods
addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#1 parameter
Parameters
pathpathpathpathPath— The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.
addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.
addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#notes · 2 parameters
To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.
Parameters
pathpathpathpathPath— - The path of the property, you can use dot notation to override values in complex types.valuevaluevaluevalueValue— - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#1 parameter
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#Syntactic sugar for addOverride("Properties.<...>", value).
2 parameters
Parameters
propertyPathproperty_pathpropertyPathpropertyPathPropertyPath— The path of the property.valuevaluevaluevalueValue— The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#notes
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.
1 parameter
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.
1 parameter
Parameters
attributeNameattribute_nameattributeNameattributeNameAttributeName— The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#1 parameter
Parameters
inspectorinspectorinspectorinspectorInspector— tree inspector to collect and process attributes.
isCfnConfigurationProfile(x: any): boolean@staticmethod def is_cfn_configuration_profile(x: Any) -> boolpublic static Boolean isCfnConfigurationProfile(Object x)public static bool IsCfnConfigurationProfile(object x)func IsCfnConfigurationProfile(X interface{}) *boolstatic#isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.
returns
Returns: The construct as a stack element or undefined if it is not a stack element.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.
overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#1 parameter
Parameters
newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId— The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#2 parameters
Parameters
targettargettargettargetTarget— The dependency to replace.newTargetnew_targetnewTargetnewTargetNewTarget— The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#returns
Returns: a string representation of this resource
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.