CfnDistributionConfiguration

class aws_cdk.aws_imagebuilder.CfnDistributionConfiguration(scope, id, *, distributions, name, description=None, tags=None)

Bases: CfnResource

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
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_imagebuilder as imagebuilder

# ami_distribution_configuration: Any
# container_distribution_configuration: Any

cfn_distribution_configuration = imagebuilder.CfnDistributionConfiguration(self, "MyCfnDistributionConfiguration",
    distributions=[imagebuilder.CfnDistributionConfiguration.DistributionProperty(
        region="region",

        # the properties below are optional
        ami_distribution_configuration=ami_distribution_configuration,
        container_distribution_configuration=container_distribution_configuration,
        fast_launch_configurations=[imagebuilder.CfnDistributionConfiguration.FastLaunchConfigurationProperty(
            account_id="accountId",
            enabled=False,
            launch_template=imagebuilder.CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty(
                launch_template_id="launchTemplateId",
                launch_template_name="launchTemplateName",
                launch_template_version="launchTemplateVersion"
            ),
            max_parallel_launches=123,
            snapshot_configuration=imagebuilder.CfnDistributionConfiguration.FastLaunchSnapshotConfigurationProperty(
                target_resource_count=123
            )
        )],
        launch_template_configurations=[imagebuilder.CfnDistributionConfiguration.LaunchTemplateConfigurationProperty(
            account_id="accountId",
            launch_template_id="launchTemplateId",
            set_default_version=False
        )],
        license_configuration_arns=["licenseConfigurationArns"]
    )],
    name="name",

    # the properties below are optional
    description="description",
    tags={
        "tags_key": "tags"
    }
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
distributions (Union[IResolvable, Sequence[Union[IResolvable, DistributionProperty, Dict[str, Any]]]]) – The distributions of this distribution configuration formatted as an array of Distribution objects.
name (str) – The name of this distribution configuration.
description (Optional[str]) – The description of this distribution configuration.
tags (Optional[Mapping[str, str]]) – The tags of this distribution configuration.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ImageBuilder::DistributionConfiguration'

attr_arn

Returns the Amazon Resource Name (ARN) of this distribution configuration.

The following pattern is applied: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+)\.(?:x|\d+)\.(?:x|\d+))(?:/\d+)?)?$ .

CloudformationAttribute:: Arn

attr_name

Returns the name of the distribution configuration.

CloudformationAttribute:: Name

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description: The description of this distribution configuration.

distributions: The distributions of this distribution configuration formatted as an array of Distribution objects.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of this distribution configuration.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: The tags of this distribution configuration.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

AmiDistributionConfigurationProperty

class CfnDistributionConfiguration.AmiDistributionConfigurationProperty(*, ami_tags=None, description=None, kms_key_id=None, launch_permission_configuration=None, name=None, target_account_ids=None)

Bases: object

Define and configure the output AMIs of the pipeline.

Parameters:

ami_tags (Union[IResolvable, Mapping[str, str], None]) – The tags to apply to AMIs distributed to this Region.
description (Optional[str]) – The description of the AMI distribution configuration. Minimum and maximum length are in characters.
kms_key_id (Optional[str]) – The KMS key identifier used to encrypt the distributed image.
launch_permission_configuration (Union[IResolvable, LaunchPermissionConfigurationProperty, Dict[str, Any], None]) – Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
name (Optional[str]) – The name of the output AMI.
target_account_ids (Optional[Sequence[str]]) – The ID of an account to which you want to distribute an image.

See:

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

ami_distribution_configuration_property = imagebuilder.CfnDistributionConfiguration.AmiDistributionConfigurationProperty(
    ami_tags={
        "ami_tags_key": "amiTags"
    },
    description="description",
    kms_key_id="kmsKeyId",
    launch_permission_configuration=imagebuilder.CfnDistributionConfiguration.LaunchPermissionConfigurationProperty(
        organizational_unit_arns=["organizationalUnitArns"],
        organization_arns=["organizationArns"],
        user_groups=["userGroups"],
        user_ids=["userIds"]
    ),
    name="name",
    target_account_ids=["targetAccountIds"]
)

Attributes

ami_tags

The tags to apply to AMIs distributed to this Region.

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

description

The description of the AMI distribution configuration.

Minimum and maximum length are in characters.

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

kms_key_id

The KMS key identifier used to encrypt the distributed image.

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

launch_permission_configuration

Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.

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

name

The name of the output AMI.

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

target_account_ids

The ID of an account to which you want to distribute an image.

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

ContainerDistributionConfigurationProperty

class CfnDistributionConfiguration.ContainerDistributionConfigurationProperty(*, container_tags=None, description=None, target_repository=None)

Bases: object

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

Parameters:

container_tags (Optional[Sequence[str]]) – Tags that are attached to the container distribution configuration.
description (Optional[str]) – The description of the container distribution configuration.
target_repository (Union[IResolvable, TargetContainerRepositoryProperty, Dict[str, Any], None]) – The destination repository for the container distribution configuration.

See:

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

container_distribution_configuration_property = imagebuilder.CfnDistributionConfiguration.ContainerDistributionConfigurationProperty(
    container_tags=["containerTags"],
    description="description",
    target_repository=imagebuilder.CfnDistributionConfiguration.TargetContainerRepositoryProperty(
        repository_name="repositoryName",
        service="service"
    )
)

Attributes

container_tags

Tags that are attached to the container distribution configuration.

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

description

The description of the container distribution configuration.

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

target_repository

The destination repository for the container distribution configuration.

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

DistributionProperty

class CfnDistributionConfiguration.DistributionProperty(*, region, ami_distribution_configuration=None, container_distribution_configuration=None, fast_launch_configurations=None, launch_template_configurations=None, license_configuration_arns=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:

region (str) – The target Region for the Distribution Configuration. For example, eu-west-1 .
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 .

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 import aws_imagebuilder as imagebuilder

# ami_distribution_configuration: Any
# container_distribution_configuration: Any

distribution_property = imagebuilder.CfnDistributionConfiguration.DistributionProperty(
    region="region",

    # the properties below are optional
    ami_distribution_configuration=ami_distribution_configuration,
    container_distribution_configuration=container_distribution_configuration,
    fast_launch_configurations=[imagebuilder.CfnDistributionConfiguration.FastLaunchConfigurationProperty(
        account_id="accountId",
        enabled=False,
        launch_template=imagebuilder.CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty(
            launch_template_id="launchTemplateId",
            launch_template_name="launchTemplateName",
            launch_template_version="launchTemplateVersion"
        ),
        max_parallel_launches=123,
        snapshot_configuration=imagebuilder.CfnDistributionConfiguration.FastLaunchSnapshotConfigurationProperty(
            target_resource_count=123
        )
    )],
    launch_template_configurations=[imagebuilder.CfnDistributionConfiguration.LaunchTemplateConfigurationProperty(
        account_id="accountId",
        launch_template_id="launchTemplateId",
        set_default_version=False
    )],
    license_configuration_arns=["licenseConfigurationArns"]
)

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

FastLaunchConfigurationProperty

class CfnDistributionConfiguration.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 import aws_imagebuilder as imagebuilder

fast_launch_configuration_property = imagebuilder.CfnDistributionConfiguration.FastLaunchConfigurationProperty(
    account_id="accountId",
    enabled=False,
    launch_template=imagebuilder.CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty(
        launch_template_id="launchTemplateId",
        launch_template_name="launchTemplateName",
        launch_template_version="launchTemplateVersion"
    ),
    max_parallel_launches=123,
    snapshot_configuration=imagebuilder.CfnDistributionConfiguration.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 CfnDistributionConfiguration.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 import aws_imagebuilder as imagebuilder

fast_launch_launch_template_specification_property = imagebuilder.CfnDistributionConfiguration.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 CfnDistributionConfiguration.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 import aws_imagebuilder as imagebuilder

fast_launch_snapshot_configuration_property = imagebuilder.CfnDistributionConfiguration.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

LaunchPermissionConfigurationProperty

class CfnDistributionConfiguration.LaunchPermissionConfigurationProperty(*, organizational_unit_arns=None, organization_arns=None, user_groups=None, user_ids=None)

Bases: object

Describes the configuration for a launch permission.

The launch permission modification request is sent to the Amazon EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all . See the examples for making an AMI public at Amazon EC2 ModifyImageAttribute .

Parameters:

organizational_unit_arns (Optional[Sequence[str]]) – The ARN for an AWS Organizations organizational unit (OU) that you want to share your AMI with. For more information about key concepts for AWS Organizations , see AWS Organizations terminology and concepts .
organization_arns (Optional[Sequence[str]]) – The ARN for an AWS Organization that you want to share your AMI with. For more information, see What is AWS Organizations ? .
user_groups (Optional[Sequence[str]]) – The name of the group.
user_ids (Optional[Sequence[str]]) – The AWS account ID.

See:

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

launch_permission_configuration_property = imagebuilder.CfnDistributionConfiguration.LaunchPermissionConfigurationProperty(
    organizational_unit_arns=["organizationalUnitArns"],
    organization_arns=["organizationArns"],
    user_groups=["userGroups"],
    user_ids=["userIds"]
)

Attributes

organization_arns

The ARN for an AWS Organization that you want to share your AMI with.

For more information, see What is AWS Organizations ? .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-organizationarns

organizational_unit_arns

The ARN for an AWS Organizations organizational unit (OU) that you want to share your AMI with.

For more information about key concepts for AWS Organizations , see AWS Organizations terminology and concepts .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-organizationalunitarns

user_groups

The name of the group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-usergroups

user_ids

The AWS account ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-launchpermissionconfiguration.html#cfn-imagebuilder-distributionconfiguration-launchpermissionconfiguration-userids

LaunchTemplateConfigurationProperty

class CfnDistributionConfiguration.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 import aws_imagebuilder as imagebuilder

launch_template_configuration_property = imagebuilder.CfnDistributionConfiguration.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

TargetContainerRepositoryProperty

class CfnDistributionConfiguration.TargetContainerRepositoryProperty(*, repository_name=None, service=None)

Bases: object

The container repository where the output container image is stored.

Parameters:

repository_name (Optional[str]) – The name of the container repository where the output container image is stored. This name is prefixed by the repository location.
service (Optional[str]) – Specifies the service in which this image was registered.

See:

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

target_container_repository_property = imagebuilder.CfnDistributionConfiguration.TargetContainerRepositoryProperty(
    repository_name="repositoryName",
    service="service"
)

Attributes

repository_name

The name of the container repository where the output container image is stored.

This name is prefixed by the repository location.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-targetcontainerrepository.html#cfn-imagebuilder-distributionconfiguration-targetcontainerrepository-repositoryname

service

Specifies the service in which this image was registered.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-targetcontainerrepository.html#cfn-imagebuilder-distributionconfiguration-targetcontainerrepository-service