libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ImageBuilder.CreateComponent

Description

Creates a new component that can be used to build, validate, test, and assess your image.

Synopsis

Creating a Request

data CreateComponent Source #

See: newCreateComponent smart constructor.

Constructors

CreateComponent' 

Fields

  • data' :: Maybe Text

    The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

  • supportedOsVersions :: Maybe (NonEmpty Text)

    The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

  • uri :: Maybe Text

    The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

  • kmsKeyId :: Maybe Text

    The ID of the KMS key that should be used to encrypt this component.

  • changeDescription :: Maybe Text

    The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

  • description :: Maybe Text

    The description of the component. Describes the contents of the component.

  • tags :: Maybe (HashMap Text Text)

    The tags of the component.

  • name :: Text

    The name of the component.

  • semanticVersion :: Text

    The semantic version of the component. This version follows the semantic version syntax.

    The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

    Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

    Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

  • platform :: Platform

    The platform of the component.

  • clientToken :: Text

    The idempotency token of the component.

Instances

Instances details
Eq CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

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

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

Read CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

readsPrec :: Int -> ReadS CreateComponent #

readList :: ReadS [CreateComponent] #

readPrec :: ReadPrec CreateComponent #

readListPrec :: ReadPrec [CreateComponent] #

Show CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

showsPrec :: Int -> CreateComponent -> ShowS #

show :: CreateComponent -> String #

showList :: [CreateComponent] -> ShowS #

Generic CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Associated Types

type Rep CreateComponent :: Type -> Type #

Methods

from :: CreateComponent -> Rep CreateComponent x #

to :: Rep CreateComponent x -> CreateComponent #

NFData CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

rnf :: CreateComponent -> () #

Hashable CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

hashWithSalt :: Int -> CreateComponent -> Int #

hash :: CreateComponent -> Int #

ToJSON CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

toJSON :: CreateComponent -> Value #

toEncoding :: CreateComponent -> Encoding #

toJSONList :: [CreateComponent] -> Value #

toEncodingList :: [CreateComponent] -> Encoding #

AWSRequest CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Associated Types

type AWSResponse CreateComponent #

Methods

request :: CreateComponent -> Request CreateComponent #

response :: MonadResource m => Logger -> Service -> Proxy CreateComponent -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateComponent))) #

ToHeaders CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

toHeaders :: CreateComponent -> [Header] #

ToPath CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

toPath :: CreateComponent -> ByteString #

ToQuery CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

toQuery :: CreateComponent -> QueryString #

type Rep CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

type Rep CreateComponent = D1 ('MetaData "CreateComponent" "Amazonka.ImageBuilder.CreateComponent" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "CreateComponent'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "data'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "supportedOsVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text)))) :*: (S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "changeDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "semanticVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "platform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Platform) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse CreateComponent Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

type AWSResponse CreateComponent = CreateComponentResponse

newCreateComponent Source #

Arguments

:: Text

$sel:name:CreateComponent'

-> Text

$sel:semanticVersion:CreateComponent'

-> Platform

$sel:platform:CreateComponent'

-> Text

$sel:clientToken:CreateComponent'

-> CreateComponent 

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

$sel:data':CreateComponent', createComponent_data - The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

$sel:supportedOsVersions:CreateComponent', createComponent_supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

$sel:uri:CreateComponent', createComponent_uri - The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

$sel:kmsKeyId:CreateComponent', createComponent_kmsKeyId - The ID of the KMS key that should be used to encrypt this component.

$sel:changeDescription:CreateComponent', createComponent_changeDescription - The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

$sel:description:CreateComponent', createComponent_description - The description of the component. Describes the contents of the component.

$sel:tags:CreateComponent', createComponent_tags - The tags of the component.

$sel:name:CreateComponent', createComponent_name - The name of the component.

$sel:semanticVersion:CreateComponent', createComponent_semanticVersion - The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

$sel:platform:CreateComponent', createComponent_platform - The platform of the component.

$sel:clientToken:CreateComponent', createComponent_clientToken - The idempotency token of the component.

Request Lenses

createComponent_data :: Lens' CreateComponent (Maybe Text) Source #

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

createComponent_supportedOsVersions :: Lens' CreateComponent (Maybe (NonEmpty Text)) Source #

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.

createComponent_uri :: Lens' CreateComponent (Maybe Text) Source #

The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

createComponent_kmsKeyId :: Lens' CreateComponent (Maybe Text) Source #

The ID of the KMS key that should be used to encrypt this component.

createComponent_changeDescription :: Lens' CreateComponent (Maybe Text) Source #

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

createComponent_description :: Lens' CreateComponent (Maybe Text) Source #

The description of the component. Describes the contents of the component.

createComponent_tags :: Lens' CreateComponent (Maybe (HashMap Text Text)) Source #

The tags of the component.

createComponent_name :: Lens' CreateComponent Text Source #

The name of the component.

createComponent_semanticVersion :: Lens' CreateComponent Text Source #

The semantic version of the component. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

createComponent_platform :: Lens' CreateComponent Platform Source #

The platform of the component.

createComponent_clientToken :: Lens' CreateComponent Text Source #

The idempotency token of the component.

Destructuring the Response

data CreateComponentResponse Source #

See: newCreateComponentResponse smart constructor.

Constructors

CreateComponentResponse' 

Fields

Instances

Instances details
Eq CreateComponentResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

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

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

Read CreateComponentResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

readsPrec :: Int -> ReadS CreateComponentResponse #

readList :: ReadS [CreateComponentResponse] #

readPrec :: ReadPrec CreateComponentResponse #

readListPrec :: ReadPrec [CreateComponentResponse] #

Show CreateComponentResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

showsPrec :: Int -> CreateComponentResponse -> ShowS #

show :: CreateComponentResponse -> String #

showList :: [CreateComponentResponse] -> ShowS #

Generic CreateComponentResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Associated Types

type Rep CreateComponentResponse :: Type -> Type #

Methods

from :: CreateComponentResponse -> Rep CreateComponentResponse x #

to :: Rep CreateComponentResponse x -> CreateComponentResponse #

NFData CreateComponentResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

Methods

rnf :: CreateComponentResponse -> () #

type Rep CreateComponentResponse Source # 
Instance details

Defined in Amazonka.ImageBuilder.CreateComponent

type Rep CreateComponentResponse = D1 ('MetaData "CreateComponentResponse" "Amazonka.ImageBuilder.CreateComponent" "libZSservicesZSamazonka-imagebuilderZSamazonka-imagebuilder" 'False) (C1 ('MetaCons "CreateComponentResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "componentBuildVersionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateComponentResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateComponentResponse'

-> CreateComponentResponse 

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

$sel:requestId:CreateComponentResponse', createComponentResponse_requestId - The request ID that uniquely identifies this request.

$sel:clientToken:CreateComponent', createComponentResponse_clientToken - The idempotency token used to make this request idempotent.

$sel:componentBuildVersionArn:CreateComponentResponse', createComponentResponse_componentBuildVersionArn - The Amazon Resource Name (ARN) of the component that was created by this request.

$sel:httpStatus:CreateComponentResponse', createComponentResponse_httpStatus - The response's http status code.

Response Lenses

createComponentResponse_requestId :: Lens' CreateComponentResponse (Maybe Text) Source #

The request ID that uniquely identifies this request.

createComponentResponse_clientToken :: Lens' CreateComponentResponse (Maybe Text) Source #

The idempotency token used to make this request idempotent.

createComponentResponse_componentBuildVersionArn :: Lens' CreateComponentResponse (Maybe Text) Source #

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

createComponentResponse_httpStatus :: Lens' CreateComponentResponse Int Source #

The response's http status code.