Class: Aws::Imagebuilder::Types::CreateInfrastructureConfigurationRequest

Inherits:

Struct

Object
Struct
Aws::Imagebuilder::Types::CreateInfrastructureConfigurationRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-imagebuilder/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#client_token ⇒ String

Unique, case-sensitive identifier you provide to ensure idempotency of the request.
#description ⇒ String

The description of the infrastructure configuration.
#instance_metadata_options ⇒ Types::InstanceMetadataOptions

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

The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
#instance_types ⇒ Array<String>

The instance types of the infrastructure configuration.
#key_pair ⇒ String

The key pair of the infrastructure configuration.
#logging ⇒ Types::Logging

The logging configuration of the infrastructure configuration.
#name ⇒ String

The name of the infrastructure configuration.
#placement ⇒ Types::Placement

The instance placement settings that define where the instances that are launched from your image will run.
#resource_tags ⇒ Hash<String,String>

The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process.
#security_group_ids ⇒ Array<String>

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

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

The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
#tags ⇒ Hash<String,String>

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

The terminate instance on failure setting of the infrastructure configuration.

Instance Attribute Details

#client_token ⇒ `String`

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

[1]: docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html

Returns:

(String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

The description of the infrastructure configuration.

Returns:

(String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_metadata_options ⇒ `Types::InstanceMetadataOptions`

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

Returns:

(Types::InstanceMetadataOptions)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_profile_name ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_types ⇒ `Array<String>`

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.

Returns:

(Array<String>)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#key_pair ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#logging ⇒ `Types::Logging`

The logging configuration of the infrastructure configuration.

Returns:

(Types::Logging)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the infrastructure configuration.

Returns:

(String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#placement ⇒ `Types::Placement`

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

Returns:

(Types::Placement)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_tags ⇒ `Hash<String,String>`

The metadata tags to assign to the Amazon EC2 instance that Image Builder launches during the build process. Tags are formatted as key value pairs.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ `String`

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

<note markdown=“1”> 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.

</note>

Returns:

(String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_id ⇒ `String`

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

Returns:

(String)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The metadata tags to assign to the infrastructure configuration resource that Image Builder creates as output. Tags are formatted as key value pairs.

Returns:

(Hash<String,String>)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#terminate_instance_on_failure ⇒ `Boolean`

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.

Returns:

(Boolean)

# File 'lib/aws-sdk-imagebuilder/types.rb', line 1664

class CreateInfrastructureConfigurationRequest < Struct.new(
  :name,
  :description,
  :instance_types,
  :instance_profile_name,
  :security_group_ids,
  :subnet_id,
  :logging,
  :key_pair,
  :terminate_instance_on_failure,
  :sns_topic_arn,
  :resource_tags,
  :instance_metadata_options,
  :tags,
  :placement,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::Imagebuilder::Types::CreateInfrastructureConfigurationRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

#description ⇒ String

#instance_metadata_options ⇒ Types::InstanceMetadataOptions

#instance_profile_name ⇒ String

#instance_types ⇒ Array<String>

#key_pair ⇒ String

#logging ⇒ Types::Logging

#name ⇒ String

#placement ⇒ Types::Placement

#resource_tags ⇒ Hash<String,String>

#security_group_ids ⇒ Array<String>

#sns_topic_arn ⇒ String

#subnet_id ⇒ String

#tags ⇒ Hash<String,String>

#terminate_instance_on_failure ⇒ Boolean

#client_token ⇒ `String`

#description ⇒ `String`

#instance_metadata_options ⇒ `Types::InstanceMetadataOptions`

#instance_profile_name ⇒ `String`

#instance_types ⇒ `Array<String>`

#key_pair ⇒ `String`

#logging ⇒ `Types::Logging`

#name ⇒ `String`

#placement ⇒ `Types::Placement`

#resource_tags ⇒ `Hash<String,String>`

#security_group_ids ⇒ `Array<String>`

#sns_topic_arn ⇒ `String`

#subnet_id ⇒ `String`

#tags ⇒ `Hash<String,String>`

#terminate_instance_on_failure ⇒ `Boolean`