amazonka-imagebuilder-2.0: Amazon EC2 Image Builder SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Description

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

Synopsis

Creating a Request

data UpdateInfrastructureConfiguration Source #

See: newUpdateInfrastructureConfiguration smart constructor.

Constructors

UpdateInfrastructureConfiguration' 

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. For more information about instance metadata options, see one of the following links:

  • 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 to place the instance used to customize your Amazon EC2 AMI in.

  • 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.

  • infrastructureConfigurationArn :: Text

    The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

  • 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 UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

toJSON :: UpdateInfrastructureConfiguration -> Value #

toEncoding :: UpdateInfrastructureConfiguration -> Encoding #

toJSONList :: [UpdateInfrastructureConfiguration] -> Value #

toEncodingList :: [UpdateInfrastructureConfiguration] -> Encoding #

ToHeaders UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

toHeaders :: UpdateInfrastructureConfiguration -> [Header] #

ToPath UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

toPath :: UpdateInfrastructureConfiguration -> ByteString #

ToQuery UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

toQuery :: UpdateInfrastructureConfiguration -> QueryString #

AWSRequest UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Associated Types

type AWSResponse UpdateInfrastructureConfiguration #

Methods

request :: (Service -> Service) -> UpdateInfrastructureConfiguration -> Request UpdateInfrastructureConfiguration #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateInfrastructureConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateInfrastructureConfiguration))) #

Generic UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Associated Types

type Rep UpdateInfrastructureConfiguration :: Type -> Type #

Methods

from :: UpdateInfrastructureConfiguration -> Rep UpdateInfrastructureConfiguration x #

to :: Rep UpdateInfrastructureConfiguration x -> UpdateInfrastructureConfiguration #

Read UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

readsPrec :: Int -> ReadS UpdateInfrastructureConfiguration #

readList :: ReadS [UpdateInfrastructureConfiguration] #

readPrec :: ReadPrec UpdateInfrastructureConfiguration #

readListPrec :: ReadPrec [UpdateInfrastructureConfiguration] #

Show UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

showsPrec :: Int -> UpdateInfrastructureConfiguration -> ShowS #

show :: UpdateInfrastructureConfiguration -> String #

showList :: [UpdateInfrastructureConfiguration] -> ShowS #

NFData UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

rnf :: UpdateInfrastructureConfiguration -> () #

Eq UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

(==) :: UpdateInfrastructureConfiguration -> UpdateInfrastructureConfiguration -> Bool #

(/=) :: UpdateInfrastructureConfiguration -> UpdateInfrastructureConfiguration -> Bool #

Hashable UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

hashWithSalt :: Int -> UpdateInfrastructureConfiguration -> Int #

hash :: UpdateInfrastructureConfiguration -> Int #

type AWSResponse UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

type AWSResponse UpdateInfrastructureConfiguration = UpdateInfrastructureConfigurationResponse
type Rep UpdateInfrastructureConfiguration Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

type Rep UpdateInfrastructureConfiguration = D1 ('MetaData "UpdateInfrastructureConfiguration" "Amazonka.ImageBuilder.UpdateInfrastructureConfiguration" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "UpdateInfrastructureConfiguration'" '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 "terminateInstanceOnFailure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "infrastructureConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "instanceProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateInfrastructureConfiguration Source #

Arguments

:: Text

UpdateInfrastructureConfiguration

-> Text

UpdateInfrastructureConfiguration

-> Text

UpdateInfrastructureConfiguration

-> UpdateInfrastructureConfiguration 

Create a value of UpdateInfrastructureConfiguration 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:

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_description - The description of the infrastructure configuration.

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_instanceMetadataOptions - The instance metadata options that you can set for the HTTP requests that pipeline builds use to launch EC2 build and test instances. For more information about instance metadata options, see one of the following links:

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_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.

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_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.

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_logging - The logging configuration of the infrastructure configuration.

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_resourceTags - The tags attached to the resource created by Image Builder.

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

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_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.

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_subnetId - The subnet ID to place the instance used to customize your Amazon EC2 AMI in.

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_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.

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

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

UpdateInfrastructureConfiguration, updateInfrastructureConfiguration_clientToken - The idempotency token used to make this request idempotent.

Request Lenses

updateInfrastructureConfiguration_description :: Lens' UpdateInfrastructureConfiguration (Maybe Text) Source #

The description of the infrastructure configuration.

updateInfrastructureConfiguration_instanceMetadataOptions :: Lens' UpdateInfrastructureConfiguration (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. For more information about instance metadata options, see one of the following links:

updateInfrastructureConfiguration_instanceTypes :: Lens' UpdateInfrastructureConfiguration (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.

updateInfrastructureConfiguration_keyPair :: Lens' UpdateInfrastructureConfiguration (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.

updateInfrastructureConfiguration_logging :: Lens' UpdateInfrastructureConfiguration (Maybe Logging) Source #

The logging configuration of the infrastructure configuration.

updateInfrastructureConfiguration_resourceTags :: Lens' UpdateInfrastructureConfiguration (Maybe (HashMap Text Text)) Source #

The tags attached to the resource created by Image Builder.

updateInfrastructureConfiguration_securityGroupIds :: Lens' UpdateInfrastructureConfiguration (Maybe [Text]) Source #

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

updateInfrastructureConfiguration_snsTopicArn :: Lens' UpdateInfrastructureConfiguration (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.

updateInfrastructureConfiguration_subnetId :: Lens' UpdateInfrastructureConfiguration (Maybe Text) Source #

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

updateInfrastructureConfiguration_terminateInstanceOnFailure :: Lens' UpdateInfrastructureConfiguration (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.

updateInfrastructureConfiguration_infrastructureConfigurationArn :: Lens' UpdateInfrastructureConfiguration Text Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that you want to update.

updateInfrastructureConfiguration_instanceProfileName :: Lens' UpdateInfrastructureConfiguration Text Source #

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

updateInfrastructureConfiguration_clientToken :: Lens' UpdateInfrastructureConfiguration Text Source #

The idempotency token used to make this request idempotent.

Destructuring the Response

data UpdateInfrastructureConfigurationResponse Source #

See: newUpdateInfrastructureConfigurationResponse smart constructor.

Constructors

UpdateInfrastructureConfigurationResponse' 

Fields

Instances

Instances details
Generic UpdateInfrastructureConfigurationResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Associated Types

type Rep UpdateInfrastructureConfigurationResponse :: Type -> Type #

Methods

from :: UpdateInfrastructureConfigurationResponse -> Rep UpdateInfrastructureConfigurationResponse x #

to :: Rep UpdateInfrastructureConfigurationResponse x -> UpdateInfrastructureConfigurationResponse #

Read UpdateInfrastructureConfigurationResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

readsPrec :: Int -> ReadS UpdateInfrastructureConfigurationResponse #

readList :: ReadS [UpdateInfrastructureConfigurationResponse] #

readPrec :: ReadPrec UpdateInfrastructureConfigurationResponse #

readListPrec :: ReadPrec [UpdateInfrastructureConfigurationResponse] #

Show UpdateInfrastructureConfigurationResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

showsPrec :: Int -> UpdateInfrastructureConfigurationResponse -> ShowS #

show :: UpdateInfrastructureConfigurationResponse -> String #

showList :: [UpdateInfrastructureConfigurationResponse] -> ShowS #

NFData UpdateInfrastructureConfigurationResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

rnf :: UpdateInfrastructureConfigurationResponse -> () #

Eq UpdateInfrastructureConfigurationResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

Methods

(==) :: UpdateInfrastructureConfigurationResponse -> UpdateInfrastructureConfigurationResponse -> Bool #

(/=) :: UpdateInfrastructureConfigurationResponse -> UpdateInfrastructureConfigurationResponse -> Bool #

type Rep UpdateInfrastructureConfigurationResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.UpdateInfrastructureConfiguration

type Rep UpdateInfrastructureConfigurationResponse = D1 ('MetaData "UpdateInfrastructureConfigurationResponse" "Amazonka.ImageBuilder.UpdateInfrastructureConfiguration" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "UpdateInfrastructureConfigurationResponse'" '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))))

newUpdateInfrastructureConfigurationResponse Source #

Arguments

:: Int

$sel:httpStatus:UpdateInfrastructureConfigurationResponse'

-> UpdateInfrastructureConfigurationResponse 

Create a value of UpdateInfrastructureConfigurationResponse 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:

UpdateInfrastructureConfiguration, updateInfrastructureConfigurationResponse_clientToken - The idempotency token used to make this request idempotent.

UpdateInfrastructureConfiguration, updateInfrastructureConfigurationResponse_infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that was updated by this request.

$sel:requestId:UpdateInfrastructureConfigurationResponse', updateInfrastructureConfigurationResponse_requestId - The request ID that uniquely identifies this request.

$sel:httpStatus:UpdateInfrastructureConfigurationResponse', updateInfrastructureConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

updateInfrastructureConfigurationResponse_clientToken :: Lens' UpdateInfrastructureConfigurationResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

updateInfrastructureConfigurationResponse_infrastructureConfigurationArn :: Lens' UpdateInfrastructureConfigurationResponse (Maybe Text) Source #

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

updateInfrastructureConfigurationResponse_requestId :: Lens' UpdateInfrastructureConfigurationResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

updateInfrastructureConfigurationResponse_httpStatus :: Lens' UpdateInfrastructureConfigurationResponse Int Source #

The response's http status code.