aws-cdk-lib.aws_imagebuilder.CfnInfrastructureConfigurationProps

interface CfnInfrastructureConfigurationProps

LanguageType name
.NETAmazon.CDK.AWS.ImageBuilder.CfnInfrastructureConfigurationProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsimagebuilder#CfnInfrastructureConfigurationProps
Javasoftware.amazon.awscdk.services.imagebuilder.CfnInfrastructureConfigurationProps
Pythonaws_cdk.aws_imagebuilder.CfnInfrastructureConfigurationProps
TypeScript aws-cdk-lib » 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 { aws_imagebuilder as imagebuilder } from 'aws-cdk-lib';
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

NameTypeDescription
instanceProfileNamestringThe instance profile of the infrastructure configuration.
namestringThe name of the infrastructure configuration.
description?stringThe description of the infrastructure configuration.
instanceMetadataOptions?IResolvable | InstanceMetadataOptionsPropertyThe instance metadata option settings for the infrastructure configuration.
instanceTypes?string[]The instance types of the infrastructure configuration.
keyPair?stringThe Amazon EC2 key pair of the infrastructure configuration.
logging?IResolvable | LoggingPropertyThe 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?stringThe Amazon Resource Name (ARN) of the SNS topic for the infrastructure configuration.
subnetId?stringThe subnet ID of the infrastructure configuration.
tags?{ [string]: string }The tags of the infrastructure configuration.
terminateInstanceOnFailure?boolean | IResolvableThe 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.