SourcedConfigurationProps

class aws_cdk.aws_appconfig.SourcedConfigurationProps(*, deletion_protection_check=None, deployment_key=None, deployment_strategy=None, deploy_to=None, description=None, name=None, type=None, validators=None, application, location, retrieval_role=None, version_number=None)

Bases: ConfigurationProps

Properties for SourcedConfiguration.

Parameters:

  • deletion_protection_check (Optional[DeletionProtectionCheck]) – 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. Default: DeletionProtectionCheck.ACCOUNT_DEFAULT

  • deployment_key (Optional[IKey]) – The deployment key of the configuration. Default: - None.

  • deployment_strategy (Optional[IDeploymentStrategy]) – The deployment strategy for the configuration. Default: - A deployment strategy with the rollout strategy set to RolloutStrategy.CANARY_10_PERCENT_20_MINUTES

  • deploy_to (Optional[Sequence[IEnvironment]]) – The list of environments to deploy the configuration to. If this parameter is not specified, then there will be no deployment created alongside this configuration. Deployments can be added later using the IEnvironment.addDeployment or IEnvironment.addDeployments methods. Default: - None.

  • description (Optional[str]) – The description of the configuration. Default: - No description.

  • name (Optional[str]) – The name of the configuration. Default: - A name is generated.

  • type (Optional[ConfigurationType]) – The type of configuration. Default: ConfigurationType.FREEFORM

  • validators (Optional[Sequence[IValidator]]) – The validators for the configuration. Default: - No validators.

  • application (IApplication) – The application associated with the configuration.

  • location (ConfigurationSource) – The location where the configuration is stored.

  • retrieval_role (Optional[IRole]) – The IAM role to retrieve the configuration. Default: - Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.

  • version_number (Optional[str]) – The version number of the sourced configuration to deploy. If this is not specified, then there will be no deployment. Default: - None.

ExampleMetadata:

infused

Example:

# application: appconfig.Application
# bucket: s3.Bucket


appconfig.SourcedConfiguration(self, "MySourcedConfiguration",
    application=application,
    location=appconfig.ConfigurationSource.from_bucket(bucket, "path/to/file.json"),
    type=appconfig.ConfigurationType.FEATURE_FLAGS,
    name="MyConfig",
    description="This is my sourced configuration from CDK."
)

Attributes

application

The application associated with the configuration.

deletion_protection_check

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.

Default:

DeletionProtectionCheck.ACCOUNT_DEFAULT

See:

https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html

deploy_to

The list of environments to deploy the configuration to.

If this parameter is not specified, then there will be no deployment created alongside this configuration.

Deployments can be added later using the IEnvironment.addDeployment or IEnvironment.addDeployments methods.

Default:

  • None.

deployment_key

The deployment key of the configuration.

Default:

  • None.

deployment_strategy

The deployment strategy for the configuration.

Default:

  • A deployment strategy with the rollout strategy set to

RolloutStrategy.CANARY_10_PERCENT_20_MINUTES

description

The description of the configuration.

Default:

  • No description.

location

The location where the configuration is stored.

name

The name of the configuration.

Default:

  • A name is generated.

retrieval_role

The IAM role to retrieve the configuration.

Default:

  • Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.

type

The type of configuration.

Default:

ConfigurationType.FREEFORM

validators

The validators for the configuration.

Default:

  • No validators.

version_number

The version number of the sourced configuration to deploy.

If this is not specified, then there will be no deployment.

Default:

  • None.