interface CfnInfrastructureConfigurationProps

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.CfnInfrastructureConfigurationProps
Java	software.amazon.awscdk.services.imagebuilder.CfnInfrastructureConfigurationProps
Python	aws_cdk.aws_imagebuilder.CfnInfrastructureConfigurationProps
TypeScript	@aws-cdk/aws-imagebuilder » CfnInfrastructureConfigurationProps

Properties for defining a CfnInfrastructureConfiguration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as imagebuilder from '@aws-cdk/aws-imagebuilder';
const cfnInfrastructureConfigurationProps: imagebuilder.CfnInfrastructureConfigurationProps = {
  instanceProfileName: 'instanceProfileName',
  name: 'name',

  // the properties below are optional
  description: 'description',
  instanceMetadataOptions: {
    httpPutResponseHopLimit: 123,
    httpTokens: 'httpTokens',
  },
  instanceTypes: ['instanceTypes'],
  keyPair: 'keyPair',
  logging: {
    s3Logs: {
      s3BucketName: 's3BucketName',
      s3KeyPrefix: 's3KeyPrefix',
    },
  },
  resourceTags: {
    resourceTagsKey: 'resourceTags',
  },
  securityGroupIds: ['securityGroupIds'],
  snsTopicArn: 'snsTopicArn',
  subnetId: 'subnetId',
  tags: {
    tagsKey: 'tags',
  },
  terminateInstanceOnFailure: false,
};

Properties

Name	Type	Description
instanceProfileName	string	The instance profile of the infrastructure configuration.
name	string	The name of the infrastructure configuration.
description?	string	The description of the infrastructure configuration.
instanceMetadataOptions?	IResolvable | InstanceMetadataOptionsProperty	The instance metadata option settings for the infrastructure configuration.
instanceTypes?	string[]	The instance types of the infrastructure configuration.
keyPair?	string	The Amazon EC2 key pair of the infrastructure configuration.
logging?	IResolvable | LoggingProperty	The logging configuration defines where Image Builder uploads your logs.
resourceTags?	IResolvable | { [string]: string }	The tags attached to the resource created by Image Builder.
securityGroupIds?	string[]	The security group IDs of the infrastructure configuration.
snsTopicArn?	string	The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.
subnetId?	string	The subnet ID of the infrastructure configuration.
tags?	{ [string]: string }	The tags of the infrastructure configuration.
terminateInstanceOnFailure?	boolean | IResolvable	The terminate instance on failure configuration of the infrastructure configuration.

---

instanceProfileName

Type: string

The instance profile of the infrastructure configuration.

---

name

Type: string

The name of the infrastructure configuration.

---

description?

Type: string (optional)

The description of the infrastructure configuration.

---

instanceMetadataOptions?

Type: IResolvable | InstanceMetadataOptionsProperty (optional)

The instance metadata option settings for the infrastructure configuration.

---

instanceTypes?

Type: string[] (optional)

The instance types of the infrastructure configuration.

---

keyPair?

Type: string (optional)

The Amazon EC2 key pair of the infrastructure configuration.

---

logging?

Type: IResolvable | LoggingProperty (optional)

The logging configuration defines where Image Builder uploads your logs.

---

resourceTags?

Type: IResolvable | { [string]: string } (optional)

The tags attached to the resource created by Image Builder.

---

securityGroupIds?

Type: string[] (optional)

The security group IDs of the infrastructure configuration.

---

snsTopicArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.

---

subnetId?

Type: string (optional)

The subnet ID of the infrastructure configuration.

---

tags?

Type: { [string]: string } (optional)

The tags of the infrastructure configuration.

---

terminateInstanceOnFailure?

Type: boolean | IResolvable (optional)

The terminate instance on failure configuration of the infrastructure configuration.