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
System.Object
CfnElement
CfnRefElement
CfnResource
CfnDistributionConfiguration
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.ImageBuilder
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDistributionConfiguration : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnDistributionConfiguration
    Inherits CfnResource
    Implements IInspectable, 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" }
    } },
    Name = "name",

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

Synopsis

Constructors

CfnDistributionConfiguration(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnDistributionConfiguration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnDistributionConfiguration(Construct, String, ICfnDistributionConfigurationProps)

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
Description

The description of this distribution configuration.
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

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnDistributionConfiguration(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnDistributionConfiguration(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnDistributionConfiguration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnDistributionConfiguration(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnDistributionConfiguration(Construct, String, ICfnDistributionConfigurationProps)

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

Scope in which this resource is defined.

id System.String

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

props ICfnDistributionConfigurationProps

Resource properties.

Properties

AttrArn

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

public virtual string AttrArn { get; }
Property Value

System.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

System.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

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Description

The description of this distribution configuration.

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

System.String

Distributions

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

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

System.Object

Name

The name of this distribution configuration.

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

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

The tags of this distribution configuration.

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

System.Collections.Generic.IDictionary<System.String, System.String>

Methods

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.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements