SourcedConfigurationOptions

class aws_cdk.aws_appconfig_alpha.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

(deprecated) Options for SourcedConfiguration.

Parameters:

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

  • deployment_strategy (Optional[IDeploymentStrategy]) – (deprecated) 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]]) – (deprecated) The list of environments to deploy the configuration to. If this parameter is not specified, then there will be no deployment. Default: - None.

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

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

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

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

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

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

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

Stability:

deprecated

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appconfig_alpha as appconfig_alpha
from aws_cdk import aws_iam as iam
from aws_cdk import aws_kms as kms

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

sourced_configuration_options = appconfig_alpha.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_alpha.ConfigurationType.FREEFORM,
    validators=[validator],
    version_number="versionNumber"
)

Attributes

deploy_to

(deprecated) The list of environments to deploy the configuration to.

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

Default:

  • None.

Stability:

deprecated

deployment_key

(deprecated) The deployment key of the configuration.

Default:

  • None.

Stability:

deprecated

deployment_strategy

(deprecated) The deployment strategy for the configuration.

Default:

  • A deployment strategy with the rollout strategy set to

RolloutStrategy.CANARY_10_PERCENT_20_MINUTES

Stability:

deprecated

description

(deprecated) The description of the configuration.

Default:

  • No description.

Stability:

deprecated

location

(deprecated) The location where the configuration is stored.

Stability:

deprecated

name

(deprecated) The name of the configuration.

Default:

  • A name is generated.

Stability:

deprecated

retrieval_role

(deprecated) The IAM role to retrieve the configuration.

Default:

  • A role is generated.

Stability:

deprecated

type

(deprecated) The type of configuration.

Default:

ConfigurationType.FREEFORM

Stability:

deprecated

validators

(deprecated) The validators for the configuration.

Default:

  • No validators.

Stability:

deprecated

version_number

(deprecated) The version number of the sourced configuration to deploy.

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

Default:

  • None.

Stability:

deprecated