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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new image pipeline. Image pipelines enable you to automate the creation and distribution of images.

Synopsis

data CreateImagePipeline = CreateImagePipeline' {
- containerRecipeArn :: Maybe Text
- description :: Maybe Text
- distributionConfigurationArn :: Maybe Text
- enhancedImageMetadataEnabled :: Maybe Bool
- imageRecipeArn :: Maybe Text
- imageTestsConfiguration :: Maybe ImageTestsConfiguration
- schedule :: Maybe Schedule
- status :: Maybe PipelineStatus
- tags :: Maybe (HashMap Text Text)
- name :: Text
- infrastructureConfigurationArn :: Text
- clientToken :: Text
}
newCreateImagePipeline :: Text -> Text -> Text -> CreateImagePipeline
createImagePipeline_containerRecipeArn :: Lens' CreateImagePipeline (Maybe Text)
createImagePipeline_description :: Lens' CreateImagePipeline (Maybe Text)
createImagePipeline_distributionConfigurationArn :: Lens' CreateImagePipeline (Maybe Text)
createImagePipeline_enhancedImageMetadataEnabled :: Lens' CreateImagePipeline (Maybe Bool)
createImagePipeline_imageRecipeArn :: Lens' CreateImagePipeline (Maybe Text)
createImagePipeline_imageTestsConfiguration :: Lens' CreateImagePipeline (Maybe ImageTestsConfiguration)
createImagePipeline_schedule :: Lens' CreateImagePipeline (Maybe Schedule)
createImagePipeline_status :: Lens' CreateImagePipeline (Maybe PipelineStatus)
createImagePipeline_tags :: Lens' CreateImagePipeline (Maybe (HashMap Text Text))
createImagePipeline_name :: Lens' CreateImagePipeline Text
createImagePipeline_infrastructureConfigurationArn :: Lens' CreateImagePipeline Text
createImagePipeline_clientToken :: Lens' CreateImagePipeline Text
data CreateImagePipelineResponse = CreateImagePipelineResponse' {
- clientToken :: Maybe Text
- imagePipelineArn :: Maybe Text
- requestId :: Maybe Text
- httpStatus :: Int
}
newCreateImagePipelineResponse :: Int -> CreateImagePipelineResponse
createImagePipelineResponse_clientToken :: Lens' CreateImagePipelineResponse (Maybe Text)
createImagePipelineResponse_imagePipelineArn :: Lens' CreateImagePipelineResponse (Maybe Text)
createImagePipelineResponse_requestId :: Lens' CreateImagePipelineResponse (Maybe Text)
createImagePipelineResponse_httpStatus :: Lens' CreateImagePipelineResponse Int

Creating a Request

data CreateImagePipeline Source #

See: newCreateImagePipeline smart constructor.

Constructors

CreateImagePipeline'

Fields

containerRecipeArn :: Maybe Text
The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.
description :: Maybe Text
The description of the image pipeline.
distributionConfigurationArn :: Maybe Text
The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.
enhancedImageMetadataEnabled :: Maybe Bool
Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
imageRecipeArn :: Maybe Text
The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.
imageTestsConfiguration :: Maybe ImageTestsConfiguration
The image test configuration of the image pipeline.
schedule :: Maybe Schedule
The schedule of the image pipeline.
status :: Maybe PipelineStatus
The status of the image pipeline.
tags :: Maybe (HashMap Text Text)
The tags of the image pipeline.
name :: Text
The name of the image pipeline.
infrastructureConfigurationArn :: Text
The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.
clientToken :: Text
The idempotency token used to make this request idempotent.

Instances

Instances details

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

newCreateImagePipeline Source #

Arguments

:: Text	`CreateImagePipeline`
-> Text	`CreateImagePipeline`
-> Text	`CreateImagePipeline`
-> CreateImagePipeline

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

CreateImagePipeline, createImagePipeline_containerRecipeArn - The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.

CreateImagePipeline, createImagePipeline_description - The description of the image pipeline.

CreateImagePipeline, createImagePipeline_distributionConfigurationArn - The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.

CreateImagePipeline, createImagePipeline_enhancedImageMetadataEnabled - Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

CreateImagePipeline, createImagePipeline_imageRecipeArn - The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

CreateImagePipeline, createImagePipeline_imageTestsConfiguration - The image test configuration of the image pipeline.

CreateImagePipeline, createImagePipeline_schedule - The schedule of the image pipeline.

CreateImagePipeline, createImagePipeline_status - The status of the image pipeline.

CreateImagePipeline, createImagePipeline_tags - The tags of the image pipeline.

CreateImagePipeline, createImagePipeline_name - The name of the image pipeline.

CreateImagePipeline, createImagePipeline_infrastructureConfigurationArn - The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.

CreateImagePipeline, createImagePipeline_clientToken - The idempotency token used to make this request idempotent.

Request Lenses

createImagePipeline_containerRecipeArn :: Lens' CreateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the container recipe that is used to configure images created by this container pipeline.

createImagePipeline_description :: Lens' CreateImagePipeline (Maybe Text) Source #

The description of the image pipeline.

createImagePipeline_distributionConfigurationArn :: Lens' CreateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images created by this image pipeline.

createImagePipeline_enhancedImageMetadataEnabled :: Lens' CreateImagePipeline (Maybe Bool) Source #

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

createImagePipeline_imageRecipeArn :: Lens' CreateImagePipeline (Maybe Text) Source #

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images created by this image pipeline.

createImagePipeline_imageTestsConfiguration :: Lens' CreateImagePipeline (Maybe ImageTestsConfiguration) Source #

The image test configuration of the image pipeline.

createImagePipeline_schedule :: Lens' CreateImagePipeline (Maybe Schedule) Source #

The schedule of the image pipeline.

createImagePipeline_status :: Lens' CreateImagePipeline (Maybe PipelineStatus) Source #

The status of the image pipeline.

createImagePipeline_tags :: Lens' CreateImagePipeline (Maybe (HashMap Text Text)) Source #

The tags of the image pipeline.

createImagePipeline_name :: Lens' CreateImagePipeline Text Source #

The name of the image pipeline.

createImagePipeline_infrastructureConfigurationArn :: Lens' CreateImagePipeline Text Source #

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images created by this image pipeline.

createImagePipeline_clientToken :: Lens' CreateImagePipeline Text Source #

The idempotency token used to make this request idempotent.

Destructuring the Response

data CreateImagePipelineResponse Source #

See: newCreateImagePipelineResponse smart constructor.

Constructors

CreateImagePipelineResponse'
Fields clientToken :: Maybe Text The idempotency token used to make this request idempotent. imagePipelineArn :: Maybe Text The Amazon Resource Name (ARN) of the image pipeline 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 CreateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImagePipeline Associated Types type Rep CreateImagePipelineResponse :: Type -> Type # Methods from :: CreateImagePipelineResponse -> Rep CreateImagePipelineResponse x # to :: Rep CreateImagePipelineResponse x -> CreateImagePipelineResponse #
Read CreateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImagePipeline Methods readsPrec :: Int -> ReadS CreateImagePipelineResponse # readList :: ReadS [CreateImagePipelineResponse] # readPrec :: ReadPrec CreateImagePipelineResponse # readListPrec :: ReadPrec [CreateImagePipelineResponse] #
Show CreateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImagePipeline Methods showsPrec :: Int -> CreateImagePipelineResponse -> ShowS # show :: CreateImagePipelineResponse -> String # showList :: [CreateImagePipelineResponse] -> ShowS #
NFData CreateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImagePipeline Methods rnf :: CreateImagePipelineResponse -> () #
Eq CreateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImagePipeline Methods (==) :: CreateImagePipelineResponse -> CreateImagePipelineResponse -> Bool # (/=) :: CreateImagePipelineResponse -> CreateImagePipelineResponse -> Bool #
type Rep CreateImagePipelineResponse Source #
Instance details Defined in Amazonka.ImageBuilder.CreateImagePipeline type Rep CreateImagePipelineResponse = D1 ('MetaData "CreateImagePipelineResponse" "Amazonka.ImageBuilder.CreateImagePipeline" "amazonka-imagebuilder-2.0-BBLLjX59RW72O8VbQ3vKvH" 'False) (C1 ('MetaCons "CreateImagePipelineResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "imagePipelineArn") '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))))

newCreateImagePipelineResponse Source #

Arguments

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

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

CreateImagePipeline, createImagePipelineResponse_clientToken - The idempotency token used to make this request idempotent.

$sel:imagePipelineArn:CreateImagePipelineResponse', createImagePipelineResponse_imagePipelineArn - The Amazon Resource Name (ARN) of the image pipeline that was created by this request.

$sel:requestId:CreateImagePipelineResponse', createImagePipelineResponse_requestId - The request ID that uniquely identifies this request.

$sel:httpStatus:CreateImagePipelineResponse', createImagePipelineResponse_httpStatus - The response's http status code.

Response Lenses

createImagePipelineResponse_clientToken :: Lens' CreateImagePipelineResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createImagePipelineResponse_imagePipelineArn :: Lens' CreateImagePipelineResponse (Maybe Text) Source #

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

createImagePipelineResponse_requestId :: Lens' CreateImagePipelineResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createImagePipelineResponse_httpStatus :: Lens' CreateImagePipelineResponse Int Source #

The response's http status code.