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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

Note:

When making an API call, you may pass CreateInfrastructureConfigurationRequest data as a hash:

{
  name: "ResourceName", # required
  description: "NonEmptyString",
  instance_types: ["InstanceType"],
  instance_profile_name: "InstanceProfileNameType", # required
  security_group_ids: ["NonEmptyString"],
  subnet_id: "NonEmptyString",
  logging: {
    s3_logs: {
      s3_bucket_name: "NonEmptyString",
      s3_key_prefix: "NonEmptyString",
    },
  },
  key_pair: "NonEmptyString",
  terminate_instance_on_failure: false,
  sns_topic_arn: "SnsTopicArn",
  resource_tags: {
    "TagKey" => "TagValue",
  },
  instance_metadata_options: {
    http_tokens: "HttpTokens",
    http_put_response_hop_limit: 1,
  },
  tags: {
    "TagKey" => "TagValue",
  },
  client_token: "ClientToken", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

The idempotency token used to make this request idempotent.

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

Returns:

  • (String)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the infrastructure configuration.

Returns:

  • (String)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_metadata_optionsTypes::InstanceMetadataOptions

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



1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_profile_nameString

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

Returns:

  • (String)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typesArray<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>)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#key_pairString

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)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#loggingTypes::Logging

The logging configuration of the infrastructure configuration.

Returns:



1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the infrastructure configuration.

Returns:

  • (String)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#resource_tagsHash<String,String>

The tags attached to the resource created by Image Builder.

Returns:

  • (Hash<String,String>)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<String>

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

Returns:

  • (Array<String>)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arnString

The SNS topic on which to send image build events.

Returns:

  • (String)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idString

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

Returns:

  • (String)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags of the infrastructure configuration.

Returns:

  • (Hash<String,String>)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#terminate_instance_on_failureBoolean

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)


1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 1776

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,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end