Skip to content

Create Infrastructure Configuration

imagebuilder_create_infrastructure_configuration R Documentation

Creates a new infrastructure configuration

Description

Creates a new infrastructure configuration. An infrastructure configuration defines the environment in which your image will be built and tested.

Usage

imagebuilder_create_infrastructure_configuration(name, description,
  instanceTypes, instanceProfileName, securityGroupIds, subnetId, logging,
  keyPair, terminateInstanceOnFailure, snsTopicArn, resourceTags,
  instanceMetadataOptions, tags, clientToken)

Arguments

name

[required] The name of the infrastructure configuration.

description

The description of the infrastructure configuration.

instanceTypes

The instance types of the infrastructure configuration. 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.

instanceProfileName

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

securityGroupIds

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

subnetId

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

logging

The logging configuration of the infrastructure configuration.

keyPair

The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.

terminateInstanceOnFailure

The terminate instance on failure setting of the infrastructure configuration. 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.

snsTopicArn

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

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.

resourceTags

The tags attached to the resource created by Image Builder.

instanceMetadataOptions

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

tags

The tags of the infrastructure configuration.

clientToken

[required] Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Value

A list with the following syntax: 

list(
  requestId = "string",
  clientToken = "string",
  infrastructureConfigurationArn = "string"
)

Request syntax

svc$create_infrastructure_configuration(
  name = "string",
  description = "string",
  instanceTypes = list(
    "string"
  ),
  instanceProfileName = "string",
  securityGroupIds = list(
    "string"
  ),
  subnetId = "string",
  logging = list(
    s3Logs = list(
      s3BucketName = "string",
      s3KeyPrefix = "string"
    )
  ),
  keyPair = "string",
  terminateInstanceOnFailure = TRUE|FALSE,
  snsTopicArn = "string",
  resourceTags = list(
    "string"
  ),
  instanceMetadataOptions = list(
    httpTokens = "string",
    httpPutResponseHopLimit = 123
  ),
  tags = list(
    "string"
  ),
  clientToken = "string"
)