Class CfnDistributionConfiguration

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnDistributionConfiguration
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDistributionConfiguration : CfnResource, IInspectable, IDistributionConfigurationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnDistributionConfiguration Inherits CfnResource Implements IInspectable, IDistributionConfigurationRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

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 amiDistributionConfiguration;
             var containerDistributionConfiguration;

             var cfnDistributionConfiguration = new CfnDistributionConfiguration(this, "MyCfnDistributionConfiguration", new CfnDistributionConfigurationProps {
                 Distributions = new [] { new DistributionProperty {
                     Region = "region",

                     // the properties below are optional
                     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" },
                     SsmParameterConfigurations = new [] { new SsmParameterConfigurationProperty {
                         ParameterName = "parameterName",

                         // the properties below are optional
                         AmiAccountId = "amiAccountId",
                         DataType = "dataType"
                     } }
                 } },
                 Name = "name",

                 // the properties below are optional
                 Description = "description",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnDistributionConfiguration(Construct, string, ICfnDistributionConfigurationProps)

Create a new AWS::ImageBuilder::DistributionConfiguration.

Properties

AttrArn

Returns the Amazon Resource Name (ARN) of this distribution configuration.
AttrName

Returns the name of the distribution configuration.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .
CfnPropertyNames

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .
Description

The description of this distribution configuration.
DistributionConfigurationRef

A reference to a DistributionConfiguration resource.
Distributions

The distributions of this distribution configuration formatted as an array of Distribution objects.
Name

The name of this distribution configuration.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The tags of this distribution configuration.

Methods

ArnForDistributionConfiguration(IDistributionConfigurationRef)

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnDistributionConfiguration(object)

Checks whether the given object is a CfnDistributionConfiguration.
RenderProperties(IDictionary<string, object>)

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .

Constructors

CfnDistributionConfiguration(Construct, string, ICfnDistributionConfigurationProps)

Create a new AWS::ImageBuilder::DistributionConfiguration.

public CfnDistributionConfiguration(Construct scope, string id, ICfnDistributionConfigurationProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDistributionConfigurationProps

Resource properties.

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

Properties

AttrArn

Returns the Amazon Resource Name (ARN) of this distribution configuration.

public virtual string AttrArn { get; }
Property Value

string

Remarks

The following pattern is applied: ^arn:aws[^:]*:imagebuilder:[^:]+:(?:\d{12}|aws):(?:image-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\d+).(?:x|\d+).(?:x|\d+))(?:/\d+)?)?$ .

CloudformationAttribute: Arn

AttrName

Returns the name of the distribution configuration.

public virtual string AttrName { get; }
Property Value

string

Remarks

CloudformationAttribute: Name

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

CfnProperties

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

CfnPropertyNames

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

Description

The description of this distribution configuration.

public virtual string? Description { get; set; }
Property Value

string

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

DistributionConfigurationRef

A reference to a DistributionConfiguration resource.

public virtual IDistributionConfigurationReference DistributionConfigurationRef { get; }
Property Value

IDistributionConfigurationReference

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

Distributions

The distributions of this distribution configuration formatted as an array of Distribution objects.

public virtual object Distributions { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDistributionConfiguration.IDistributionProperty)[]

Name

The name of this distribution configuration.

public virtual string Name { get; set; }
Property Value

string

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

TagsRaw

The tags of this distribution configuration.

public virtual IDictionary<string, string>? TagsRaw { get; set; }
Property Value

IDictionary<string, string>

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

Methods

ArnForDistributionConfiguration(IDistributionConfigurationRef)

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .

public static string ArnForDistributionConfiguration(IDistributionConfigurationRef resource)
Parameters
resource IDistributionConfigurationRef
Returns

string

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

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 amiDistributionConfiguration;
             var containerDistributionConfiguration;

             var cfnDistributionConfiguration = new CfnDistributionConfiguration(this, "MyCfnDistributionConfiguration", new CfnDistributionConfigurationProps {
                 Distributions = new [] { new DistributionProperty {
                     Region = "region",

                     // the properties below are optional
                     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" },
                     SsmParameterConfigurations = new [] { new SsmParameterConfigurationProperty {
                         ParameterName = "parameterName",

                         // the properties below are optional
                         AmiAccountId = "amiAccountId",
                         DataType = "dataType"
                     } }
                 } },
                 Name = "name",

                 // the properties below are optional
                 Description = "description",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

IsCfnDistributionConfiguration(object)

Checks whether the given object is a CfnDistributionConfiguration.

public static bool IsCfnDistributionConfiguration(object x)
Parameters
x object
Returns

bool

Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

A distribution configuration allows you to specify the name and description of your output AMI, authorize other AWS account s to launch the AMI, and replicate the AMI to other AWS Regions .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

It also allows you to export the AMI to Amazon S3 .

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

CloudformationResource: AWS::ImageBuilder::DistributionConfiguration

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable