interface DistributionProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.ImageBuilder.CfnDistributionConfiguration.DistributionProperty |
Java | software.amazon.awscdk.services.imagebuilder.CfnDistributionConfiguration.DistributionProperty |
Python | aws_cdk.aws_imagebuilder.CfnDistributionConfiguration.DistributionProperty |
TypeScript | @aws-cdk/aws-imagebuilder » CfnDistributionConfiguration » DistributionProperty |
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
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as imagebuilder from '@aws-cdk/aws-imagebuilder';
declare const amiDistributionConfiguration: any;
declare const containerDistributionConfiguration: any;
const distributionProperty: imagebuilder.CfnDistributionConfiguration.DistributionProperty = {
region: 'region',
// the properties below are optional
amiDistributionConfiguration: amiDistributionConfiguration,
containerDistributionConfiguration: containerDistributionConfiguration,
fastLaunchConfigurations: [{
accountId: 'accountId',
enabled: false,
launchTemplate: {
launchTemplateId: 'launchTemplateId',
launchTemplateName: 'launchTemplateName',
launchTemplateVersion: 'launchTemplateVersion',
},
maxParallelLaunches: 123,
snapshotConfiguration: {
targetResourceCount: 123,
},
}],
launchTemplateConfigurations: [{
accountId: 'accountId',
launchTemplateId: 'launchTemplateId',
setDefaultVersion: false,
}],
licenseConfigurationArns: ['licenseConfigurationArns'],
};
Properties
Name | Type | Description |
---|---|---|
region | string | The target Region for the Distribution Configuration. |
ami | any | The specific AMI settings, such as launch permissions and AMI tags. |
container | any | Container distribution settings for encryption, licensing, and sharing in a specific Region. |
fast | IResolvable | IResolvable | Fast [] | CfnDistributionConfiguration.DistributionProperty.FastLaunchConfigurations . |
launch | IResolvable | IResolvable | Launch [] | A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts. |
license | string[] | The License Manager Configuration to associate with the AMI in the specified Region. |
region
Type:
string
The target Region for the Distribution Configuration.
For example, eu-west-1
.
amiDistributionConfiguration?
Type:
any
(optional)
The specific AMI settings, such as launch permissions and AMI tags.
For details, see example schema below.
containerDistributionConfiguration?
Type:
any
(optional)
Container distribution settings for encryption, licensing, and sharing in a specific Region.
For details, see example schema below.
fastLaunchConfigurations?
Type:
IResolvable
|
IResolvable
|
Fast
[]
(optional)
CfnDistributionConfiguration.DistributionProperty.FastLaunchConfigurations
.
launchTemplateConfigurations?
Type:
IResolvable
|
IResolvable
|
Launch
[]
(optional)
A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
licenseConfigurationArns?
Type:
string[]
(optional)
The License Manager Configuration to associate with the AMI in the specified Region.
For more information, see the LicenseConfiguration API .