amazonka-cloudformation-2.0: Amazon CloudFormation 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.CloudFormation.PublishType

Description

Publishes the specified extension to the CloudFormation registry as a public extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing extensions, see Publishing extensions to make them available for public use in the CloudFormation CLI User Guide.

To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see RegisterPublisher.

Synopsis

Creating a Request

data PublishType Source #

See: newPublishType smart constructor.

Constructors

PublishType' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

  • publicVersionNumber :: Maybe Text

    The version number to assign to this version of the extension.

    Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

    MAJOR.MINOR.PATCH

    For more information, see Semantic Versioning 2.0.0.

    If you don't specify a version number, CloudFormation increments the version number by one minor version release.

    You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

  • type' :: Maybe ThirdPartyType

    The type of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

  • typeName :: Maybe Text

    The name of the extension.

    Conditional: You must specify Arn, or TypeName and Type.

Instances

Instances details
ToHeaders PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

toHeaders :: PublishType -> [Header] #

ToPath PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

toPath :: PublishType -> ByteString #

ToQuery PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

toQuery :: PublishType -> QueryString #

AWSRequest PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Associated Types

type AWSResponse PublishType #

Methods

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

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

Generic PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Associated Types

type Rep PublishType :: Type -> Type #

Methods

from :: PublishType -> Rep PublishType x #

to :: Rep PublishType x -> PublishType #

Read PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

readsPrec :: Int -> ReadS PublishType #

readList :: ReadS [PublishType] #

readPrec :: ReadPrec PublishType #

readListPrec :: ReadPrec [PublishType] #

Show PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

showsPrec :: Int -> PublishType -> ShowS #

show :: PublishType -> String #

showList :: [PublishType] -> ShowS #

NFData PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

rnf :: PublishType -> () #

Eq PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

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

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

Hashable PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

hashWithSalt :: Int -> PublishType -> Int #

hash :: PublishType -> Int #

type AWSResponse PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

type AWSResponse PublishType = PublishTypeResponse
type Rep PublishType Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

type Rep PublishType = D1 ('MetaData "PublishType" "Amazonka.CloudFormation.PublishType" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "PublishType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "publicVersionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThirdPartyType)) :*: S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newPublishType :: PublishType Source #

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

PublishType, publishType_arn - The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn, or TypeName and Type.

PublishType, publishType_publicVersionNumber - The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0.

If you don't specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

PublishType, publishType_type - The type of the extension.

Conditional: You must specify Arn, or TypeName and Type.

PublishType, publishType_typeName - The name of the extension.

Conditional: You must specify Arn, or TypeName and Type.

Request Lenses

publishType_arn :: Lens' PublishType (Maybe Text) Source #

The Amazon Resource Name (ARN) of the extension.

Conditional: You must specify Arn, or TypeName and Type.

publishType_publicVersionNumber :: Lens' PublishType (Maybe Text) Source #

The version number to assign to this version of the extension.

Use the following format, and adhere to semantic versioning when assigning a version number to your extension:

MAJOR.MINOR.PATCH

For more information, see Semantic Versioning 2.0.0.

If you don't specify a version number, CloudFormation increments the version number by one minor version release.

You cannot specify a version number the first time you publish a type. CloudFormation automatically sets the first version number to be 1.0.0.

publishType_type :: Lens' PublishType (Maybe ThirdPartyType) Source #

The type of the extension.

Conditional: You must specify Arn, or TypeName and Type.

publishType_typeName :: Lens' PublishType (Maybe Text) Source #

The name of the extension.

Conditional: You must specify Arn, or TypeName and Type.

Destructuring the Response

data PublishTypeResponse Source #

See: newPublishTypeResponse smart constructor.

Constructors

PublishTypeResponse' 

Fields

Instances

Instances details
Generic PublishTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Associated Types

type Rep PublishTypeResponse :: Type -> Type #

Methods

from :: PublishTypeResponse -> Rep PublishTypeResponse x #

to :: Rep PublishTypeResponse x -> PublishTypeResponse #

Read PublishTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

readsPrec :: Int -> ReadS PublishTypeResponse #

readList :: ReadS [PublishTypeResponse] #

readPrec :: ReadPrec PublishTypeResponse #

readListPrec :: ReadPrec [PublishTypeResponse] #

Show PublishTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

showsPrec :: Int -> PublishTypeResponse -> ShowS #

show :: PublishTypeResponse -> String #

showList :: [PublishTypeResponse] -> ShowS #

NFData PublishTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

rnf :: PublishTypeResponse -> () #

Eq PublishTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

Methods

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

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

type Rep PublishTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.PublishType

type Rep PublishTypeResponse = D1 ('MetaData "PublishTypeResponse" "Amazonka.CloudFormation.PublishType" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "PublishTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "publicTypeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPublishTypeResponse Source #

Arguments

:: Int

$sel:httpStatus:PublishTypeResponse'

-> PublishTypeResponse 

Create a value of PublishTypeResponse 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:publicTypeArn:PublishTypeResponse', publishTypeResponse_publicTypeArn - The Amazon Resource Name (ARN) assigned to the public extension upon publication.

$sel:httpStatus:PublishTypeResponse', publishTypeResponse_httpStatus - The response's http status code.

Response Lenses

publishTypeResponse_publicTypeArn :: Lens' PublishTypeResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) assigned to the public extension upon publication.

publishTypeResponse_httpStatus :: Lens' PublishTypeResponse Int Source #

The response's http status code.