CfnDistributionConfigurationPropsMixin

class aws_cdk.mixins_preview.aws_imagebuilder.mixins.CfnDistributionConfigurationPropsMixin(props, *, strategy=None)

Bases: Mixin

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .

It also allows you to export the AMI to Amazon S3 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-distributionconfiguration.html

CloudformationResource:

AWS::ImageBuilder::DistributionConfiguration

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

# ami_distribution_configuration: Any
# container_distribution_configuration: Any

cfn_distribution_configuration_props_mixin = imagebuilder_mixins.CfnDistributionConfigurationPropsMixin(imagebuilder_mixins.CfnDistributionConfigurationMixinProps(
    description="description",
    distributions=[imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.DistributionProperty(
        ami_distribution_configuration=ami_distribution_configuration,
        container_distribution_configuration=container_distribution_configuration,
        fast_launch_configurations=[imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchConfigurationProperty(
            account_id="accountId",
            enabled=False,
            launch_template=imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchLaunchTemplateSpecificationProperty(
                launch_template_id="launchTemplateId",
                launch_template_name="launchTemplateName",
                launch_template_version="launchTemplateVersion"
            ),
            max_parallel_launches=123,
            snapshot_configuration=imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchSnapshotConfigurationProperty(
                target_resource_count=123
            )
        )],
        launch_template_configurations=[imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.LaunchTemplateConfigurationProperty(
            account_id="accountId",
            launch_template_id="launchTemplateId",
            set_default_version=False
        )],
        license_configuration_arns=["licenseConfigurationArns"],
        region="region",
        ssm_parameter_configurations=[imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.SsmParameterConfigurationProperty(
            ami_account_id="amiAccountId",
            data_type="dataType",
            parameter_name="parameterName"
        )]
    )],
    name="name",
    tags={
        "tags_key": "tags"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ImageBuilder::DistributionConfiguration.

Parameters:

• props (Union[CfnDistributionConfigurationMixinProps, Dict[str, Any]]) – L1 properties to apply.

• strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'distributions', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) 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.

Stability:

experimental

DistributionProperty

class CfnDistributionConfigurationPropsMixin.DistributionProperty(*, ami_distribution_configuration=None, container_distribution_configuration=None, fast_launch_configurations=None, launch_template_configurations=None, license_configuration_arns=None, region=None, ssm_parameter_configurations=None)

Bases: object

The distribution configuration distribution defines the settings for a specific Region in the Distribution Configuration.

You must specify whether the distribution is for an AMI or a container image. To do so, include exactly one of the following data types for your distribution:

• amiDistributionConfiguration

• containerDistributionConfiguration

Parameters:

• ami_distribution_configuration (Any) – The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.

• container_distribution_configuration (Any) – Container distribution settings for encryption, licensing, and sharing in a specific Region. For details, see example schema below.

• fast_launch_configurations (Union[IResolvable, Sequence[Union[IResolvable, FastLaunchConfigurationProperty, Dict[str, Any]]], None]) – The Windows faster-launching configurations to use for AMI distribution.

• launch_template_configurations (Union[IResolvable, Sequence[Union[IResolvable, LaunchTemplateConfigurationProperty, Dict[str, Any]]], None]) – A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

• license_configuration_arns (Optional[Sequence[str]]) – The License Manager Configuration to associate with the AMI in the specified Region. For more information, see the LicenseConfiguration API .

• region (Optional[str]) – The target Region for the Distribution Configuration. For example, eu-west-1 .

• ssm_parameter_configurations (Union[IResolvable, Sequence[Union[IResolvable, SsmParameterConfigurationProperty, Dict[str, Any]]], None]) – Contains settings to update AWS Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

# ami_distribution_configuration: Any
# container_distribution_configuration: Any

distribution_property = imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.DistributionProperty(
    ami_distribution_configuration=ami_distribution_configuration,
    container_distribution_configuration=container_distribution_configuration,
    fast_launch_configurations=[imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchConfigurationProperty(
        account_id="accountId",
        enabled=False,
        launch_template=imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchLaunchTemplateSpecificationProperty(
            launch_template_id="launchTemplateId",
            launch_template_name="launchTemplateName",
            launch_template_version="launchTemplateVersion"
        ),
        max_parallel_launches=123,
        snapshot_configuration=imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchSnapshotConfigurationProperty(
            target_resource_count=123
        )
    )],
    launch_template_configurations=[imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.LaunchTemplateConfigurationProperty(
        account_id="accountId",
        launch_template_id="launchTemplateId",
        set_default_version=False
    )],
    license_configuration_arns=["licenseConfigurationArns"],
    region="region",
    ssm_parameter_configurations=[imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.SsmParameterConfigurationProperty(
        ami_account_id="amiAccountId",
        data_type="dataType",
        parameter_name="parameterName"
    )]
)

Attributes

ami_distribution_configuration

The specific AMI settings, such as launch permissions and AMI tags.

For details, see example schema below.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-amidistributionconfiguration

container_distribution_configuration

Container distribution settings for encryption, licensing, and sharing in a specific Region.

For details, see example schema below.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-containerdistributionconfiguration

fast_launch_configurations

The Windows faster-launching configurations to use for AMI distribution.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-fastlaunchconfigurations

launch_template_configurations

A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-launchtemplateconfigurations

license_configuration_arns

The License Manager Configuration to associate with the AMI in the specified Region.

For more information, see the LicenseConfiguration API .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-licenseconfigurationarns

region

The target Region for the Distribution Configuration.

For example, eu-west-1 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-region

ssm_parameter_configurations

Contains settings to update AWS Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.html#cfn-imagebuilder-distributionconfiguration-distribution-ssmparameterconfigurations

FastLaunchConfigurationProperty

class CfnDistributionConfigurationPropsMixin.FastLaunchConfigurationProperty(*, account_id=None, enabled=None, launch_template=None, max_parallel_launches=None, snapshot_configuration=None)

Bases: object

Define and configure faster launching for output Windows AMIs.

Parameters:

• account_id (Optional[str]) – The owner account ID for the fast-launch enabled Windows AMI.

• enabled (Union[bool, IResolvable, None]) – A Boolean that represents the current state of faster launching for the Windows AMI. Set to true to start using Windows faster launching, or false to stop using it.

• launch_template (Union[IResolvable, FastLaunchLaunchTemplateSpecificationProperty, Dict[str, Any], None]) – The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.

• max_parallel_launches (Union[int, float, None]) – The maximum number of parallel instances that are launched for creating resources.

• snapshot_configuration (Union[IResolvable, FastLaunchSnapshotConfigurationProperty, Dict[str, Any], None]) – Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

fast_launch_configuration_property = imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchConfigurationProperty(
    account_id="accountId",
    enabled=False,
    launch_template=imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchLaunchTemplateSpecificationProperty(
        launch_template_id="launchTemplateId",
        launch_template_name="launchTemplateName",
        launch_template_version="launchTemplateVersion"
    ),
    max_parallel_launches=123,
    snapshot_configuration=imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchSnapshotConfigurationProperty(
        target_resource_count=123
    )
)

Attributes

account_id

The owner account ID for the fast-launch enabled Windows AMI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-accountid

enabled

A Boolean that represents the current state of faster launching for the Windows AMI.

Set to true to start using Windows faster launching, or false to stop using it.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-enabled

launch_template

The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances to create pre-provisioned snapshots.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-launchtemplate

max_parallel_launches

The maximum number of parallel instances that are launched for creating resources.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-maxparallellaunches

snapshot_configuration

Configuration settings for managing the number of snapshots that are created from pre-provisioned instances for the Windows AMI when faster launching is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchconfiguration-snapshotconfiguration

FastLaunchLaunchTemplateSpecificationProperty

class CfnDistributionConfigurationPropsMixin.FastLaunchLaunchTemplateSpecificationProperty(*, launch_template_id=None, launch_template_name=None, launch_template_version=None)

Bases: object

Identifies the launch template that the associated Windows AMI uses for launching an instance when faster launching is enabled.

You can specify either the launchTemplateName or the launchTemplateId , but not both.

Parameters:

• launch_template_id (Optional[str]) – The ID of the launch template to use for faster launching for a Windows AMI.

• launch_template_name (Optional[str]) – The name of the launch template to use for faster launching for a Windows AMI.

• launch_template_version (Optional[str]) – The version of the launch template to use for faster launching for a Windows AMI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

fast_launch_launch_template_specification_property = imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchLaunchTemplateSpecificationProperty(
    launch_template_id="launchTemplateId",
    launch_template_name="launchTemplateName",
    launch_template_version="launchTemplateVersion"
)

Attributes

launch_template_id

The ID of the launch template to use for faster launching for a Windows AMI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html#cfn-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification-launchtemplateid

launch_template_name

The name of the launch template to use for faster launching for a Windows AMI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html#cfn-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification-launchtemplatename

launch_template_version

The version of the launch template to use for faster launching for a Windows AMI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification.html#cfn-imagebuilder-distributionconfiguration-fastlaunchlaunchtemplatespecification-launchtemplateversion

FastLaunchSnapshotConfigurationProperty

class CfnDistributionConfigurationPropsMixin.FastLaunchSnapshotConfigurationProperty(*, target_resource_count=None)

Bases: object

Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.

Parameters:

target_resource_count (Union[int, float, None]) – The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchsnapshotconfiguration.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

fast_launch_snapshot_configuration_property = imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.FastLaunchSnapshotConfigurationProperty(
    target_resource_count=123
)

Attributes

target_resource_count

The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-fastlaunchsnapshotconfiguration.html#cfn-imagebuilder-distributionconfiguration-fastlaunchsnapshotconfiguration-targetresourcecount

LaunchTemplateConfigurationProperty

class CfnDistributionConfigurationPropsMixin.LaunchTemplateConfigurationProperty(*, account_id=None, launch_template_id=None, set_default_version=None)

Bases: object

Identifies an Amazon EC2 launch template to use for a specific account.

Parameters:

• account_id (Optional[str]) – The account ID that this configuration applies to.

• launch_template_id (Optional[str]) – Identifies the Amazon EC2 launch template to use.

• set_default_version (Union[bool, IResolvable, None]) – Set the specified Amazon EC2 launch template as the default launch template for the specified account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

launch_template_configuration_property = imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.LaunchTemplateConfigurationProperty(
    account_id="accountId",
    launch_template_id="launchTemplateId",
    set_default_version=False
)

Attributes

account_id

The account ID that this configuration applies to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchtemplateconfiguration-accountid

launch_template_id

Identifies the Amazon EC2 launch template to use.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchtemplateconfiguration-launchtemplateid

set_default_version

Set the specified Amazon EC2 launch template as the default launch template for the specified account.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchtemplateconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchtemplateconfiguration-setdefaultversion

SsmParameterConfigurationProperty

class CfnDistributionConfigurationPropsMixin.SsmParameterConfigurationProperty(*, ami_account_id=None, data_type=None, parameter_name=None)

Bases: object

Configuration for a single Parameter in the AWS Systems Manager (SSM) Parameter Store in a given Region.

Parameters:

• ami_account_id (Optional[str]) – Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region.

• data_type (Optional[str]) – The data type specifies what type of value the Parameter contains. We recommend that you use data type aws:ec2:image .

• parameter_name (Optional[str]) – This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn’t already exist. Otherwise, it updates the parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.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.mixins_preview.aws_imagebuilder import mixins as imagebuilder_mixins

ssm_parameter_configuration_property = imagebuilder_mixins.CfnDistributionConfigurationPropsMixin.SsmParameterConfigurationProperty(
    ami_account_id="amiAccountId",
    data_type="dataType",
    parameter_name="parameterName"
)

Attributes

ami_account_id

Specify the account that will own the Parameter in a given Region.

During distribution, this account must be specified in distribution settings as a target account for the Region.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-amiaccountid

data_type

The data type specifies what type of value the Parameter contains.

We recommend that you use data type aws:ec2:image .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-datatype

parameter_name

This is the name of the Parameter in the target Region or account.

The image distribution creates the Parameter if it doesn’t already exist. Otherwise, it updates the parameter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-parametername