interface AmiDistribution 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.AmiDistribution
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#AmiDistribution
Java	software.amazon.awscdk.services.imagebuilder.alpha.AmiDistribution
Python	aws_cdk.aws_imagebuilder_alpha.AmiDistribution
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » AmiDistribution

The regional distribution settings to use for an AMI build.

Example

const infrastructureConfiguration = new imagebuilder.InfrastructureConfiguration(this, 'Infrastructure', {
  infrastructureConfigurationName: 'production-infrastructure',
  instanceTypes: [
    ec2.InstanceType.of(ec2.InstanceClass.COMPUTE7_INTEL, ec2.InstanceSize.LARGE)
  ],
  vpc: vpc,
  subnetSelection: { subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }
});

const distributionConfiguration = new imagebuilder.DistributionConfiguration(this, 'Distribution');
distributionConfiguration.addAmiDistributions({
  amiName: 'production-ami-{{ imagebuilder:buildDate }}',
  amiTargetAccountIds: ['123456789012', '098765432109']
});

const productionPipeline = new imagebuilder.ImagePipeline(this, 'ProductionPipeline', {
  recipe: exampleImageRecipe,
  infrastructureConfiguration: infrastructureConfiguration,
  distributionConfiguration: distributionConfiguration
});

Properties

Name	Type	Description
amiDescription?🔹	string	The description of the AMI.
amiKmsKey?🔹	IKey	The KMS key to encrypt the distributed AMI with.
amiLaunchPermission?🔹	AmiLaunchPermission	The launch permissions for the AMI, defining which principals are allowed to access the AMI.
amiName?🔹	string	The name to use for the distributed AMIs.
amiTags?🔹	{ [string]: string }	The tags to apply to the distributed AMIs.
amiTargetAccountIds?🔹	string[]	The account IDs to copy the output AMI to.
fastLaunchConfigurations?🔹	FastLaunchConfiguration[]	The fast launch configurations to use for enabling EC2 Fast Launch on the distributed Windows AMI.
launchTemplates?🔹	LaunchTemplateConfiguration[]	The launch templates to apply the distributed AMI to.
licenseConfigurationArns?🔹	string[]	The License Manager license configuration ARNs to apply to the distributed AMIs.
region?🔹	string	The target region to distribute AMIs to.
ssmParameters?🔹	SSMParameterConfigurations[]	The SSM parameters to create or update for the distributed AMIs.

---

amiDescription?🔹

Type: string (optional, default: None)

The description of the AMI.

---

amiKmsKey?🔹

Type: IKey (optional, default: None)

The KMS key to encrypt the distributed AMI with.

---

amiLaunchPermission?🔹

Type: AmiLaunchPermission (optional, default: None)

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

---

amiName?🔹

Type: string (optional, default: A name is generated from the image recipe name)

The name to use for the distributed AMIs.

---

amiTags?🔹

Type: { [string]: string } (optional, default: None)

The tags to apply to the distributed AMIs.

---

amiTargetAccountIds?🔹

Type: string[] (optional, default: None)

The account IDs to copy the output AMI to.

---

fastLaunchConfigurations?🔹

Type: FastLaunchConfiguration[] (optional, default: None)

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

See also: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableFastLaunch.html

---

launchTemplates?🔹

Type: LaunchTemplateConfiguration[] (optional, default: None)

The launch templates to apply the distributed AMI to.

---

licenseConfigurationArns?🔹

Type: string[] (optional, default: None)

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

---

region?🔹

Type: string (optional, default: The current region is used)

The target region to distribute AMIs to.

---

ssmParameters?🔹

Type: SSMParameterConfigurations[] (optional, default: None)

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