AmiDistribution

class aws_cdk.aws_imagebuilder_alpha.AmiDistribution(*, ami_description=None, ami_kms_key=None, ami_launch_permission=None, ami_name=None, ami_tags=None, ami_target_account_ids=None, fast_launch_configurations=None, launch_templates=None, license_configuration_arns=None, region=None, ssm_parameters=None)

Bases: object

(experimental) The regional distribution settings to use for an AMI build.

Parameters:

ami_description (Optional[str]) – (experimental) The description of the AMI. Default: None
ami_kms_key (Optional[IKey]) – (experimental) The KMS key to encrypt the distributed AMI with. Default: None
ami_launch_permission (Union[AmiLaunchPermission, Dict[str, Any], None]) – (experimental) The launch permissions for the AMI, defining which principals are allowed to access the AMI. Default: None
ami_name (Optional[str]) – (experimental) The name to use for the distributed AMIs. Default: A name is generated from the image recipe name
ami_tags (Optional[Mapping[str, str]]) – (experimental) The tags to apply to the distributed AMIs. Default: None
ami_target_account_ids (Optional[Sequence[str]]) – (experimental) The account IDs to copy the output AMI to. Default: None
fast_launch_configurations (Optional[Sequence[Union[FastLaunchConfiguration, Dict[str, Any]]]]) – (experimental) The fast launch configurations to use for enabling EC2 Fast Launch on the distributed Windows AMI. Default: None
launch_templates (Optional[Sequence[Union[LaunchTemplateConfiguration, Dict[str, Any]]]]) – (experimental) The launch templates to apply the distributed AMI to. Default: None
license_configuration_arns (Optional[Sequence[str]]) – (experimental) The License Manager license configuration ARNs to apply to the distributed AMIs. Default: None
region (Optional[str]) – (experimental) The target region to distribute AMIs to. Default: The current region is used
ssm_parameters (Optional[Sequence[Union[SSMParameterConfigurations, Dict[str, Any]]]]) – (experimental) The SSM parameters to create or update for the distributed AMIs. Default: None

Stability:

experimental

ExampleMetadata:

infused

Example:

infrastructure_configuration = imagebuilder.InfrastructureConfiguration(self, "Infrastructure",
    infrastructure_configuration_name="production-infrastructure",
    instance_types=[
        ec2.InstanceType.of(ec2.InstanceClass.COMPUTE7_INTEL, ec2.InstanceSize.LARGE)
    ],
    vpc=vpc,
    subnet_selection=ec2.SubnetSelection(subnet_type=ec2.SubnetType.PRIVATE_WITH_EGRESS)
)

distribution_configuration = imagebuilder.DistributionConfiguration(self, "Distribution")
distribution_configuration.add_ami_distributions(
    ami_name="production-ami-{{ imagebuilder:buildDate }}",
    ami_target_account_ids=["123456789012", "098765432109"]
)

production_pipeline = imagebuilder.ImagePipeline(self, "ProductionPipeline",
    recipe=example_image_recipe,
    infrastructure_configuration=infrastructure_configuration,
    distribution_configuration=distribution_configuration
)

Attributes

ami_description

(experimental) The description of the AMI.

Default:: None
Stability:: experimental

ami_kms_key

(experimental) The KMS key to encrypt the distributed AMI with.

Default:: None
Stability:: experimental

ami_launch_permission

(experimental) The launch permissions for the AMI, defining which principals are allowed to access the AMI.

Default:: None
Stability:: experimental

ami_name

(experimental) The name to use for the distributed AMIs.

Default:: A name is generated from the image recipe name
Stability:: experimental

ami_tags

(experimental) The tags to apply to the distributed AMIs.

Default:: None
Stability:: experimental

ami_target_account_ids

(experimental) The account IDs to copy the output AMI to.

Default:: None
Stability:: experimental

fast_launch_configurations

(experimental) The fast launch configurations to use for enabling EC2 Fast Launch on the distributed Windows AMI.

Default:: None
See:: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableFastLaunch.html
Stability:: experimental

launch_templates

(experimental) The launch templates to apply the distributed AMI to.

Default:: None
Stability:: experimental

license_configuration_arns

(experimental) The License Manager license configuration ARNs to apply to the distributed AMIs.

Default:: None
Stability:: experimental

region

(experimental) The target region to distribute AMIs to.

Default:: The current region is used
Stability:: experimental

ssm_parameters

(experimental) The SSM parameters to create or update for the distributed AMIs.

Default:: None
Stability:: experimental