Interface ICfnInfrastructureConfigurationMixinProps

Properties for CfnInfrastructureConfigurationPropsMixin.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.ImageBuilder

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface ICfnInfrastructureConfigurationMixinProps

Syntax (vb)

Public Interface ICfnInfrastructureConfigurationMixinProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.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 cfnInfrastructureConfigurationMixinProps = new CfnInfrastructureConfigurationMixinProps {
                 Description = "description",
                 InstanceMetadataOptions = new InstanceMetadataOptionsProperty {
                     HttpPutResponseHopLimit = 123,
                     HttpTokens = "httpTokens"
                 },
                 InstanceProfileName = "instanceProfileName",
                 InstanceTypes = new [] { "instanceTypes" },
                 KeyPair = "keyPair",
                 Logging = new LoggingProperty {
                     S3Logs = new S3LogsProperty {
                         S3BucketName = "s3BucketName",
                         S3KeyPrefix = "s3KeyPrefix"
                     }
                 },
                 Name = "name",
                 Placement = new PlacementProperty {
                     AvailabilityZone = "availabilityZone",
                     HostId = "hostId",
                     HostResourceGroupArn = "hostResourceGroupArn",
                     Tenancy = "tenancy"
                 },
                 ResourceTags = new Dictionary<string, string> {
                     { "resourceTagsKey", "resourceTags" }
                 },
                 SecurityGroupIds = new [] { "securityGroupIds" },
                 SnsTopicArn = "snsTopicArn",
                 SubnetId = "subnetId",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 TerminateInstanceOnFailure = false
             };

Synopsis

Properties

Description	The description of the infrastructure configuration.
InstanceMetadataOptions	The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
InstanceProfileName	The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
InstanceTypes	The instance types of the infrastructure configuration.
KeyPair	The key pair of the infrastructure configuration.
Logging	The logging configuration of the infrastructure configuration.
Name	The name of the infrastructure configuration.
Placement	The instance placement settings that define where the instances that are launched from your image will run.
ResourceTags	The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.
SecurityGroupIds	The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
SnsTopicArn	The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
SubnetId	The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
Tags	The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output.
TerminateInstanceOnFailure	The terminate instance on failure setting of the infrastructure configuration.

Properties

Description

The description of the infrastructure configuration.

string? Description { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-description

InstanceMetadataOptions

The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.

object? InstanceMetadataOptions { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instancemetadataoptions

Type union: either IResolvable or CfnInfrastructureConfigurationPropsMixin.IInstanceMetadataOptionsProperty

InstanceProfileName

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

object? InstanceProfileName { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instanceprofilename

Type union: either string or IInstanceProfileRef

InstanceTypes

The instance types of the infrastructure configuration.

string[]? InstanceTypes { get; }

Property Value

string[]

Remarks

You can specify one or more instance types to use for this build. The service will pick one of these instance types based on availability.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-instancetypes

KeyPair

The key pair of the infrastructure configuration.

string? KeyPair { get; }

Property Value

string

Remarks

You can use this to log on to and debug the instance used to create your image.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-keypair

Logging

The logging configuration of the infrastructure configuration.

object? Logging { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-logging

Type union: either IResolvable or CfnInfrastructureConfigurationPropsMixin.ILoggingProperty

Name

The name of the infrastructure configuration.

string? Name { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-name

Placement

The instance placement settings that define where the instances that are launched from your image will run.

object? Placement { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-placement

Type union: either IResolvable or CfnInfrastructureConfigurationPropsMixin.IPlacementProperty

ResourceTags

The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.

object? ResourceTags { get; }

Property Value

object

Remarks

Tags are formatted as key value pairs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-resourcetags

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

SecurityGroupIds

The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.

string[]? SecurityGroupIds { get; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-securitygroupids

SnsTopicArn

The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.

object? SnsTopicArn { get; }

Property Value

object

Remarks

EC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys from other accounts. The key that is used to encrypt the SNS topic must reside in the account that the Image Builder service runs under.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-snstopicarn

Type union: either string or ITopicRef

SubnetId

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.

string? SubnetId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-subnetid

Tags

The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output.

IDictionary<string, string>? Tags { get; }

Property Value

IDictionary<string, string>

Remarks

Tags are formatted as key value pairs.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-tags

TerminateInstanceOnFailure

The terminate instance on failure setting of the infrastructure configuration.

object? TerminateInstanceOnFailure { get; }

Property Value

object

Remarks

Set to false if you want Image Builder to retain the instance used to configure your AMI if the build or test phase of your workflow fails.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-imagebuilder-infrastructureconfiguration.html#cfn-imagebuilder-infrastructureconfiguration-terminateinstanceonfailure

Type union: either bool or IResolvable