SourcedConfigurationOptions

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

Bases: ConfigurationOptions

Options for SourcedConfiguration.

Parameters:

  • 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.

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

  • retrieval_role (Optional[IRole]) – The IAM role to retrieve the configuration. Default: - A role is generated.

  • 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:

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 import aws_appconfig as appconfig
from aws_cdk import aws_iam as iam
from aws_cdk import aws_kms as kms

# configuration_source: appconfig.ConfigurationSource
# deployment_strategy: appconfig.DeploymentStrategy
# environment: appconfig.Environment
# key: kms.Key
# role: iam.Role
# validator: appconfig.IValidator

sourced_configuration_options = appconfig.SourcedConfigurationOptions(
    location=configuration_source,

    # the properties below are optional
    deployment_key=key,
    deployment_strategy=deployment_strategy,
    deploy_to=[environment],
    description="description",
    name="name",
    retrieval_role=role,
    type=appconfig.ConfigurationType.FREEFORM,
    validators=[validator],
    version_number="versionNumber"
)

Attributes

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:

  • A role is generated.

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.