Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.ImageBuilder.CreateInfrastructureConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

Creating a Request

data CreateInfrastructureConfiguration Source #

See: newCreateInfrastructureConfiguration smart constructor.

Constructors

CreateInfrastructureConfiguration'

Fields

description :: Maybe Text
The description of the infrastructure configuration.
instanceMetadataOptions :: Maybe InstanceMetadataOptions
The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances.
instanceTypes :: Maybe [Text]
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.
keyPair :: Maybe Text
The key pair of the infrastructure configuration. You can use this to log on to and debug the instance used to create your image.
logging :: Maybe Logging
The logging configuration of the infrastructure configuration.
resourceTags :: Maybe (HashMap Text Text)
The tags attached to the resource created by Image Builder.
securityGroupIds :: Maybe [Text]
The security group IDs to associate with the instance used to customize your Amazon EC2 AMI.
snsTopicArn :: Maybe Text
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.
subnetId :: Maybe Text
The subnet ID in which to place the instance used to customize your Amazon EC2 AMI.
tags :: Maybe (HashMap Text Text)
The tags of the infrastructure configuration.
terminateInstanceOnFailure :: Maybe Bool
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.
name :: Text
The name of the infrastructure configuration.
instanceProfileName :: Text
The instance profile to associate with the instance used to customize your Amazon EC2 AMI.
clientToken :: Text
The idempotency token used to make this request idempotent.

Instances

Instances details

ToJSON CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods toJSON :: CreateInfrastructureConfiguration -> Value # toEncoding :: CreateInfrastructureConfiguration -> Encoding # toJSONList :: [CreateInfrastructureConfiguration] -> Value # toEncodingList :: [CreateInfrastructureConfiguration] -> Encoding #
ToHeaders CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods toHeaders :: CreateInfrastructureConfiguration -> [Header] #
ToPath CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods toPath :: CreateInfrastructureConfiguration -> ByteString #
ToQuery CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods toQuery :: CreateInfrastructureConfiguration -> QueryString #
AWSRequest CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Associated Types type AWSResponse CreateInfrastructureConfiguration # Methods request :: (Service -> Service) -> CreateInfrastructureConfiguration -> Request CreateInfrastructureConfiguration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateInfrastructureConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateInfrastructureConfiguration))) #
Generic CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Associated Types type Rep CreateInfrastructureConfiguration :: Type -> Type # Methods from :: CreateInfrastructureConfiguration -> Rep CreateInfrastructureConfiguration x # to :: Rep CreateInfrastructureConfiguration x -> CreateInfrastructureConfiguration #
Read CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods readsPrec :: Int -> ReadS CreateInfrastructureConfiguration # readList :: ReadS [CreateInfrastructureConfiguration] # readPrec :: ReadPrec CreateInfrastructureConfiguration # readListPrec :: ReadPrec [CreateInfrastructureConfiguration] #
Show CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods showsPrec :: Int -> CreateInfrastructureConfiguration -> ShowS # show :: CreateInfrastructureConfiguration -> String # showList :: [CreateInfrastructureConfiguration] -> ShowS #
NFData CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods rnf :: CreateInfrastructureConfiguration -> () #
Eq CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods (==) :: CreateInfrastructureConfiguration -> CreateInfrastructureConfiguration -> Bool # (/=) :: CreateInfrastructureConfiguration -> CreateInfrastructureConfiguration -> Bool #
Hashable CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods hashWithSalt :: Int -> CreateInfrastructureConfiguration -> Int # hash :: CreateInfrastructureConfiguration -> Int #
type AWSResponse CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration type AWSResponse CreateInfrastructureConfiguration = CreateInfrastructureConfigurationResponse
type Rep CreateInfrastructureConfiguration Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration type Rep CreateInfrastructureConfiguration = D1 ('MetaData "CreateInfrastructureConfiguration" "Amazonka.ImageBuilder.CreateInfrastructureConfiguration" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "CreateInfrastructureConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "instanceMetadataOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InstanceMetadataOptions)) :: S1 ('MetaSel ('Just "instanceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "keyPair") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "logging") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Logging))) :: (S1 ('MetaSel ('Just "resourceTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "snsTopicArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "subnetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "terminateInstanceOnFailure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "instanceProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateInfrastructureConfiguration Source #

Arguments

:: Text	`CreateInfrastructureConfiguration`
-> Text	`CreateInfrastructureConfiguration`
-> Text	`CreateInfrastructureConfiguration`
-> CreateInfrastructureConfiguration

Create a value of CreateInfrastructureConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateInfrastructureConfiguration, createInfrastructureConfiguration_description - The description of the infrastructure configuration.

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

CreateInfrastructureConfiguration, createInfrastructureConfiguration_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.

CreateInfrastructureConfiguration, createInfrastructureConfiguration_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.

CreateInfrastructureConfiguration, createInfrastructureConfiguration_logging - The logging configuration of the infrastructure configuration.

CreateInfrastructureConfiguration, createInfrastructureConfiguration_resourceTags - The tags attached to the resource created by Image Builder.

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

CreateInfrastructureConfiguration, createInfrastructureConfiguration_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.

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

CreateInfrastructureConfiguration, createInfrastructureConfiguration_tags - The tags of the infrastructure configuration.

CreateInfrastructureConfiguration, createInfrastructureConfiguration_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.

CreateInfrastructureConfiguration, createInfrastructureConfiguration_name - The name of the infrastructure configuration.

CreateInfrastructureConfiguration, createInfrastructureConfiguration_instanceProfileName - The instance profile to associate with the instance used to customize your Amazon EC2 AMI.

CreateInfrastructureConfiguration, createInfrastructureConfiguration_clientToken - The idempotency token used to make this request idempotent.

Request Lenses

createInfrastructureConfiguration_description :: Lens' CreateInfrastructureConfiguration (Maybe Text) Source #

The description of the infrastructure configuration.

createInfrastructureConfiguration_instanceMetadataOptions :: Lens' CreateInfrastructureConfiguration (Maybe InstanceMetadataOptions) Source #

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

createInfrastructureConfiguration_instanceTypes :: Lens' CreateInfrastructureConfiguration (Maybe [Text]) Source #

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.

createInfrastructureConfiguration_keyPair :: Lens' CreateInfrastructureConfiguration (Maybe Text) Source #

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

createInfrastructureConfiguration_logging :: Lens' CreateInfrastructureConfiguration (Maybe Logging) Source #

The logging configuration of the infrastructure configuration.

createInfrastructureConfiguration_resourceTags :: Lens' CreateInfrastructureConfiguration (Maybe (HashMap Text Text)) Source #

The tags attached to the resource created by Image Builder.

createInfrastructureConfiguration_securityGroupIds :: Lens' CreateInfrastructureConfiguration (Maybe [Text]) Source #

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

createInfrastructureConfiguration_snsTopicArn :: Lens' CreateInfrastructureConfiguration (Maybe Text) Source #

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.

createInfrastructureConfiguration_subnetId :: Lens' CreateInfrastructureConfiguration (Maybe Text) Source #

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

createInfrastructureConfiguration_tags :: Lens' CreateInfrastructureConfiguration (Maybe (HashMap Text Text)) Source #

The tags of the infrastructure configuration.

createInfrastructureConfiguration_terminateInstanceOnFailure :: Lens' CreateInfrastructureConfiguration (Maybe Bool) Source #

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.

createInfrastructureConfiguration_name :: Lens' CreateInfrastructureConfiguration Text Source #

The name of the infrastructure configuration.

createInfrastructureConfiguration_instanceProfileName :: Lens' CreateInfrastructureConfiguration Text Source #

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

createInfrastructureConfiguration_clientToken :: Lens' CreateInfrastructureConfiguration Text Source #

The idempotency token used to make this request idempotent.

Destructuring the Response

data CreateInfrastructureConfigurationResponse Source #

See: newCreateInfrastructureConfigurationResponse smart constructor.

Constructors

CreateInfrastructureConfigurationResponse'
Fields clientToken :: Maybe Text The idempotency token used to make this request idempotent. infrastructureConfigurationArn :: Maybe Text The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request. requestId :: Maybe Text The request ID that uniquely identifies this request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateInfrastructureConfigurationResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Associated Types type Rep CreateInfrastructureConfigurationResponse :: Type -> Type # Methods from :: CreateInfrastructureConfigurationResponse -> Rep CreateInfrastructureConfigurationResponse x # to :: Rep CreateInfrastructureConfigurationResponse x -> CreateInfrastructureConfigurationResponse #
Read CreateInfrastructureConfigurationResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods readsPrec :: Int -> ReadS CreateInfrastructureConfigurationResponse # readList :: ReadS [CreateInfrastructureConfigurationResponse] # readPrec :: ReadPrec CreateInfrastructureConfigurationResponse # readListPrec :: ReadPrec [CreateInfrastructureConfigurationResponse] #
Show CreateInfrastructureConfigurationResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods showsPrec :: Int -> CreateInfrastructureConfigurationResponse -> ShowS # show :: CreateInfrastructureConfigurationResponse -> String # showList :: [CreateInfrastructureConfigurationResponse] -> ShowS #
NFData CreateInfrastructureConfigurationResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods rnf :: CreateInfrastructureConfigurationResponse -> () #
Eq CreateInfrastructureConfigurationResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration Methods (==) :: CreateInfrastructureConfigurationResponse -> CreateInfrastructureConfigurationResponse -> Bool # (/=) :: CreateInfrastructureConfigurationResponse -> CreateInfrastructureConfigurationResponse -> Bool #
type Rep CreateInfrastructureConfigurationResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateInfrastructureConfiguration type Rep CreateInfrastructureConfigurationResponse = D1 ('MetaData "CreateInfrastructureConfigurationResponse" "Amazonka.ImageBuilder.CreateInfrastructureConfiguration" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "CreateInfrastructureConfigurationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "infrastructureConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateInfrastructureConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateInfrastructureConfigurationResponse'`
-> CreateInfrastructureConfigurationResponse

Create a value of CreateInfrastructureConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateInfrastructureConfiguration, createInfrastructureConfigurationResponse_clientToken - The idempotency token used to make this request idempotent.

CreateInfrastructureConfigurationResponse, createInfrastructureConfigurationResponse_infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.

$sel:requestId:CreateInfrastructureConfigurationResponse', createInfrastructureConfigurationResponse_requestId - The request ID that uniquely identifies this request.

$sel:httpStatus:CreateInfrastructureConfigurationResponse', createInfrastructureConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

createInfrastructureConfigurationResponse_clientToken :: Lens' CreateInfrastructureConfigurationResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createInfrastructureConfigurationResponse_infrastructureConfigurationArn :: Lens' CreateInfrastructureConfigurationResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that was created by this request.

createInfrastructureConfigurationResponse_requestId :: Lens' CreateInfrastructureConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createInfrastructureConfigurationResponse_httpStatus :: Lens' CreateInfrastructureConfigurationResponse Int Source #

The response's http status code.