Interface CfnDistributionConfigurationPropsMixin.IDistributionProperty

The distribution configuration distribution defines the settings for a specific Region in the Distribution Configuration.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ImageBuilder

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnDistributionConfigurationPropsMixin.IDistributionProperty

Syntax (vb)

Public Interface CfnDistributionConfigurationPropsMixin.IDistributionProperty

Remarks

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:

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-distribution.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.CfnPropertyMixins.AWS.ImageBuilder;

             var amiDistributionConfiguration;
             var containerDistributionConfiguration;

             var distributionProperty = new DistributionProperty {
                 AmiDistributionConfiguration = amiDistributionConfiguration,
                 ContainerDistributionConfiguration = containerDistributionConfiguration,
                 FastLaunchConfigurations = new [] { new FastLaunchConfigurationProperty {
                     AccountId = "accountId",
                     Enabled = false,
                     LaunchTemplate = new FastLaunchLaunchTemplateSpecificationProperty {
                         LaunchTemplateId = "launchTemplateId",
                         LaunchTemplateName = "launchTemplateName",
                         LaunchTemplateVersion = "launchTemplateVersion"
                     },
                     MaxParallelLaunches = 123,
                     SnapshotConfiguration = new FastLaunchSnapshotConfigurationProperty {
                         TargetResourceCount = 123
                     }
                 } },
                 LaunchTemplateConfigurations = new [] { new LaunchTemplateConfigurationProperty {
                     AccountId = "accountId",
                     LaunchTemplateId = "launchTemplateId",
                     SetDefaultVersion = false
                 } },
                 LicenseConfigurationArns = new [] { "licenseConfigurationArns" },
                 Region = "region",
                 SsmParameterConfigurations = new [] { new SsmParameterConfigurationProperty {
                     AmiAccountId = "amiAccountId",
                     DataType = "dataType",
                     ParameterName = "parameterName"
                 } }
             };

Synopsis

Properties

AmiDistributionConfiguration	The specific AMI settings, such as launch permissions and AMI tags.
ContainerDistributionConfiguration	Container distribution settings for encryption, licensing, and sharing in a specific Region.
FastLaunchConfigurations	The Windows faster-launching configurations to use for AMI distribution.
LaunchTemplateConfigurations	A group of launchTemplateConfiguration settings that apply to image distribution for specified accounts.
LicenseConfigurationArns	The License Manager Configuration to associate with the AMI in the specified Region.
Region	The target Region for the Distribution Configuration.
SsmParameterConfigurations	Contains settings to update AWS Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region.

Properties

AmiDistributionConfiguration

The specific AMI settings, such as launch permissions and AMI tags.

object? AmiDistributionConfiguration { get; }

Property Value

object

Remarks

For details, see example schema below.

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

ContainerDistributionConfiguration

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

object? ContainerDistributionConfiguration { get; }

Property Value

object

Remarks

For details, see example schema below.

FastLaunchConfigurations

The Windows faster-launching configurations to use for AMI distribution.

object? FastLaunchConfigurations { get; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDistributionConfigurationPropsMixin.IFastLaunchConfigurationProperty)[]

LaunchTemplateConfigurations

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

object? LaunchTemplateConfigurations { get; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDistributionConfigurationPropsMixin.ILaunchTemplateConfigurationProperty)[]

LicenseConfigurationArns

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

string[]? LicenseConfigurationArns { get; }

Property Value

string[]

Remarks

For more information, see the LicenseConfiguration API .

Region

The target Region for the Distribution Configuration.

string? Region { get; }

Property Value

string

Remarks

For example, eu-west-1 .

SsmParameterConfigurations

Contains settings to update AWS Systems Manager (SSM) Parameter Store Parameters with output AMI IDs from the build by target Region.

object? SsmParameterConfigurations { get; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDistributionConfigurationPropsMixin.ISsmParameterConfigurationProperty)[]