CfnDistributionConfiguration

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

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::ImageBuilder::DistributionConfiguration.

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 .

CloudformationResource

AWS::ImageBuilder::DistributionConfiguration

Link

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

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_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"
    }
)

Create a new AWS::ImageBuilder::DistributionConfiguration.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • 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_depends_on(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_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

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.

Return type

None

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 intermdediate 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).

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 resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

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.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

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

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

Return type

str

attr_name

Returns the name of the distribution configuration.

CloudformationAttribute

Name

Return type

str

cfn_options

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

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

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.

Return type

List[str]

description

The description of this distribution configuration.

Link

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

Return type

Optional[str]

distributions

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

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, DistributionProperty]]]

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

Return type

str

Returns

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

name

The name of this distribution configuration.

Link

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

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

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 }).

Return type

str

stack

The stack in which this element is defined.

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

Return type

Stack

tags

The tags of this distribution configuration.

Link

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

Return type

TagManager

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(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

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.

Link

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.
import aws_cdk.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.

Link

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

Return type

Union[IResolvable, Mapping[str, str], None]

description

The description of the AMI distribution configuration.

Minimum and maximum length are in characters.

Link

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

Return type

Optional[str]

kms_key_id

The KMS key identifier used to encrypt the distributed image.

Link

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

Return type

Optional[str]

launch_permission_configuration

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

Link

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

Return type

Union[IResolvable, LaunchPermissionConfigurationProperty, None]

name

The name of the output AMI.

Link

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

Return type

Optional[str]

target_account_ids

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

Link

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

Return type

Optional[List[str]]

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.

Link

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.
import aws_cdk.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.

Link

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

Return type

Optional[List[str]]

description

The description of the container distribution configuration.

Link

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

Return type

Optional[str]

target_repository

The destination repository for the container distribution configuration.

Link

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

Return type

Union[IResolvable, TargetContainerRepositoryProperty, None]

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 (Optional[Any]) – The specific AMI settings, such as launch permissions and AMI tags. For details, see example schema below.

  • container_distribution_configuration (Optional[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]) – CfnDistributionConfiguration.DistributionProperty.FastLaunchConfigurations.

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

Link

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.
import aws_cdk.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.

Link

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

Return type

Any

container_distribution_configuration

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

For details, see example schema below.

Link

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

Return type

Any

fast_launch_configurations

CfnDistributionConfiguration.DistributionProperty.FastLaunchConfigurations.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, FastLaunchConfigurationProperty]], None]

launch_template_configurations

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

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, LaunchTemplateConfigurationProperty]], None]

license_configuration_arns

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

For more information, see the LicenseConfiguration API .

Link

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

Return type

Optional[List[str]]

region

The target Region for the Distribution Configuration.

For example, eu-west-1 .

Link

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

Return type

str

FastLaunchConfigurationProperty

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

Bases: object

Parameters
  • account_id (Optional[str]) – CfnDistributionConfiguration.FastLaunchConfigurationProperty.AccountId.

  • enabled (Union[bool, IResolvable, None]) – CfnDistributionConfiguration.FastLaunchConfigurationProperty.Enabled.

  • launch_template (Union[IResolvable, FastLaunchLaunchTemplateSpecificationProperty, Dict[str, Any], None]) – CfnDistributionConfiguration.FastLaunchConfigurationProperty.LaunchTemplate.

  • max_parallel_launches (Union[int, float, None]) – CfnDistributionConfiguration.FastLaunchConfigurationProperty.MaxParallelLaunches.

  • snapshot_configuration (Union[IResolvable, FastLaunchSnapshotConfigurationProperty, Dict[str, Any], None]) – CfnDistributionConfiguration.FastLaunchConfigurationProperty.SnapshotConfiguration.

Link

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.
import aws_cdk.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

CfnDistributionConfiguration.FastLaunchConfigurationProperty.AccountId.

Link

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

Return type

Optional[str]

enabled

CfnDistributionConfiguration.FastLaunchConfigurationProperty.Enabled.

Link

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

Return type

Union[bool, IResolvable, None]

launch_template

CfnDistributionConfiguration.FastLaunchConfigurationProperty.LaunchTemplate.

Link

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

Return type

Union[IResolvable, FastLaunchLaunchTemplateSpecificationProperty, None]

max_parallel_launches

CfnDistributionConfiguration.FastLaunchConfigurationProperty.MaxParallelLaunches.

Link

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

Return type

Union[int, float, None]

snapshot_configuration

CfnDistributionConfiguration.FastLaunchConfigurationProperty.SnapshotConfiguration.

Link

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

Return type

Union[IResolvable, FastLaunchSnapshotConfigurationProperty, None]

FastLaunchLaunchTemplateSpecificationProperty

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

Bases: object

Parameters
  • launch_template_id (Optional[str]) – CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty.LaunchTemplateId.

  • launch_template_name (Optional[str]) – CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty.LaunchTemplateName.

  • launch_template_version (Optional[str]) – CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty.LaunchTemplateVersion.

Link

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.
import aws_cdk.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

CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty.LaunchTemplateId.

Link

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

Return type

Optional[str]

launch_template_name

CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty.LaunchTemplateName.

Link

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

Return type

Optional[str]

launch_template_version

CfnDistributionConfiguration.FastLaunchLaunchTemplateSpecificationProperty.LaunchTemplateVersion.

Link

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

Return type

Optional[str]

FastLaunchSnapshotConfigurationProperty

class CfnDistributionConfiguration.FastLaunchSnapshotConfigurationProperty(*, target_resource_count=None)

Bases: object

Parameters

target_resource_count (Union[int, float, None]) – CfnDistributionConfiguration.FastLaunchSnapshotConfigurationProperty.TargetResourceCount.

Link

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

fast_launch_snapshot_configuration_property = imagebuilder.CfnDistributionConfiguration.FastLaunchSnapshotConfigurationProperty(
    target_resource_count=123
)

Attributes

target_resource_count

CfnDistributionConfiguration.FastLaunchSnapshotConfigurationProperty.TargetResourceCount.

Link

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

Return type

Union[int, float, None]

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.

Link

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.
import aws_cdk.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 ? .

Link

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

Return type

Optional[List[str]]

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 .

Link

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

Return type

Optional[List[str]]

user_groups

The name of the group.

Link

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

Return type

Optional[List[str]]

user_ids

The AWS account ID.

Link

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

Return type

Optional[List[str]]

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.

Link

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.
import aws_cdk.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.

Link

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

Return type

Optional[str]

launch_template_id

Identifies the Amazon EC2 launch template to use.

Link

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

Return type

Optional[str]

set_default_version

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

Link

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

Return type

Union[bool, IResolvable, None]

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.

Link

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.
import aws_cdk.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.

Link

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

Return type

Optional[str]

service

Specifies the service in which this image was registered.

Link

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

Return type

Optional[str]