Interface CfnDistributionConfiguration.IAmiDistributionConfigurationProperty

Define and configure the output AMIs of the pipeline.

Namespace: Amazon.CDK.AWS.ImageBuilder

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnDistributionConfiguration.IAmiDistributionConfigurationProperty

Syntax (vb)

Public Interface CfnDistributionConfiguration.IAmiDistributionConfigurationProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.ImageBuilder;

             var amiDistributionConfigurationProperty = new AmiDistributionConfigurationProperty {
                 AmiTags = new Dictionary<string, string> {
                     { "amiTagsKey", "amiTags" }
                 },
                 Description = "description",
                 KmsKeyId = "kmsKeyId",
                 LaunchPermissionConfiguration = new LaunchPermissionConfigurationProperty {
                     OrganizationalUnitArns = new [] { "organizationalUnitArns" },
                     OrganizationArns = new [] { "organizationArns" },
                     UserGroups = new [] { "userGroups" },
                     UserIds = new [] { "userIds" }
                 },
                 Name = "name",
                 TargetAccountIds = new [] { "targetAccountIds" }
             };

Synopsis

Properties

AmiTags	The tags to apply to AMIs distributed to this Region.
Description	The description of the AMI distribution configuration.
KmsKeyId	The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image.
LaunchPermissionConfiguration	Launch permissions can be used to configure which AWS account s can use the AMI to launch instances.
Name	The name of the output AMI.
TargetAccountIds	The ID of an account to which you want to distribute an image.

Properties

AmiTags

The tags to apply to AMIs distributed to this Region.

object? AmiTags { get; }

Property Value

object

Remarks

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

Type union: either Dictionary<string, string> or IResolvable

Description

The description of the AMI distribution configuration.

string? Description { get; }

Property Value

string

Remarks

Minimum and maximum length are in characters.

KmsKeyId

The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt the distributed image.

string? KmsKeyId { get; }

Property Value

string

Remarks

This can be either the Key ARN or the Alias ARN. For more information, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

LaunchPermissionConfiguration

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

object? LaunchPermissionConfiguration { get; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDistributionConfiguration.ILaunchPermissionConfigurationProperty

Name

The name of the output AMI.

string? Name { get; }

Property Value

string

Remarks

TargetAccountIds

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

string[]? TargetAccountIds { get; }

Property Value

string[]