CfnConfigurationProfilePropsMixin

class aws_cdk.cfn_property_mixins.aws_appconfig.CfnConfigurationProfilePropsMixin(props, *, strategy=None)

Bases: Mixin

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html
CloudformationResource:: AWS::AppConfig::ConfigurationProfile
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appconfig as appconfig
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_configuration_profile_props_mixin = appconfig.CfnConfigurationProfilePropsMixin(appconfig.CfnConfigurationProfileMixinProps(
    application_id="applicationId",
    deletion_protection_check="deletionProtectionCheck",
    description="description",
    kms_key_identifier="kmsKeyIdentifier",
    location_uri="locationUri",
    name="name",
    retrieval_role_arn="retrievalRoleArn",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    type="type",
    validators=[appconfig.CfnConfigurationProfilePropsMixin.ValidatorsProperty(
        content="content",
        type="type"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::AppConfig::ConfigurationProfile.

Parameters:

props (Union[CfnConfigurationProfileMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationId', 'deletionProtectionCheck', 'description', 'kmsKeyIdentifier', 'locationUri', 'name', 'retrievalRoleArn', 'tags', 'type', 'validators']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

TagsProperty

class CfnConfigurationProfilePropsMixin.TagsProperty(*, key=None, value=None)

Bases: object

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.

Parameters:

key (Optional[str]) – The key-value string map. The valid character set is [a-zA-Z+-=._:/] . The tag key can be up to 128 characters and must not start with aws: .
value (Optional[str]) – The tag value can be up to 256 characters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appconfig as appconfig

tags_property = appconfig.CfnConfigurationProfilePropsMixin.TagsProperty(
    key="key",
    value="value"
)

Attributes

key

The key-value string map.

The valid character set is [a-zA-Z+-=._:/] . The tag key can be up to 128 characters and must not start with aws: .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html#cfn-appconfig-configurationprofile-tags-key

value

The tag value can be up to 256 characters.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-tags.html#cfn-appconfig-configurationprofile-tags-value

ValidatorsProperty

class CfnConfigurationProfilePropsMixin.ValidatorsProperty(*, content=None, type=None)

Bases: object

A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended.

To validate your application configuration data, you provide a schema or an AWS Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid. For more information, see About validators in the AWS AppConfig User Guide .

Parameters:

content (Union[str, IFunctionRef, None]) – Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
type (Optional[str]) – AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-validators.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_appconfig as appconfig

validators_property = appconfig.CfnConfigurationProfilePropsMixin.ValidatorsProperty(
    content="content",
    type="type"
)

Attributes

content

Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-validators.html#cfn-appconfig-configurationprofile-validators-content

type

AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-configurationprofile-validators.html#cfn-appconfig-configurationprofile-validators-type