Amazonka.CloudFormation.ActivateType

Activates a public third-party extension, making it available for use in stack templates. For more information, see Using public extensions in the CloudFormation User Guide.

Once you have activated a public third-party extension in your account and region, use SetTypeConfiguration to specify configuration properties for the extension. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

Creating a Request

data ActivateType

See: newActivateType smart constructor.

Constructors

ActivateType'

Fields

• autoUpdate :: Maybe Bool

  Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

  The default is true.

• executionRoleArn :: Maybe Text

  The name of the IAM execution role to use to activate the extension.

• loggingConfig :: Maybe LoggingConfig
• majorVersion :: Maybe Natural

  The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

  You can specify MajorVersion or VersionBump, but not both.

• publicTypeArn :: Maybe Text

  The Amazon Resource Name (ARN) of the public extension.

  Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

• publisherId :: Maybe Text

  The ID of the extension publisher.

  Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

• type' :: Maybe ThirdPartyType

  The extension type.

  Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

• typeName :: Maybe Text

  The name of the extension.

  Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

• typeNameAlias :: Maybe Text

  An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

  An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.

• versionBump :: Maybe VersionBump

  Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

  • MAJOR: CloudFormation updates the extension to the newest major version, if one is available.
  • MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

Instances

ToHeaders ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Methods

toHeaders :: ActivateType -> [Header]

ToPath ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Methods

toPath :: ActivateType -> ByteString

ToQuery ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Methods

toQuery :: ActivateType -> QueryString

AWSRequest ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Associated Types

type AWSResponse ActivateType

Methods

request :: (Service -> Service) -> ActivateType -> Request ActivateType

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

Generic ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Associated Types

type Rep ActivateType :: Type -> Type

Methods

from :: ActivateType -> Rep ActivateType x

to :: Rep ActivateType x -> ActivateType

Read ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Methods

readsPrec :: Int -> ReadS ActivateType

readList :: ReadS [ActivateType]

readPrec :: ReadPrec ActivateType

readListPrec :: ReadPrec [ActivateType]

Show ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Methods

showsPrec :: Int -> ActivateType -> ShowS

show :: ActivateType -> String

showList :: [ActivateType] -> ShowS

NFData ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Methods

rnf :: ActivateType -> ()

Eq ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Methods

(==) :: ActivateType -> ActivateType -> Bool

(/=) :: ActivateType -> ActivateType -> Bool

Hashable ActivateType

Defined in Amazonka.CloudFormation.ActivateType

Methods

hashWithSalt :: Int -> ActivateType -> Int

hash :: ActivateType -> Int

type AWSResponse ActivateType

Defined in Amazonka.CloudFormation.ActivateType

type AWSResponse ActivateType = ActivateTypeResponse

type Rep ActivateType

Defined in Amazonka.CloudFormation.ActivateType

type Rep ActivateType = D1 ('MetaData "ActivateType" "Amazonka.CloudFormation.ActivateType" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "ActivateType'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "autoUpdate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "loggingConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfig)) :*: (S1 ('MetaSel ('Just "majorVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "publicTypeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "publisherId") '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)) :*: (S1 ('MetaSel ('Just "typeNameAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "versionBump") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VersionBump)))))))

newActivateType :: ActivateType

Create a value of ActivateType 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:autoUpdate:ActivateType', activateType_autoUpdate - Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

The default is true.

$sel:executionRoleArn:ActivateType', activateType_executionRoleArn - The name of the IAM execution role to use to activate the extension.

$sel:loggingConfig:ActivateType', activateType_loggingConfig - Undocumented member.

$sel:majorVersion:ActivateType', activateType_majorVersion - The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

You can specify MajorVersion or VersionBump, but not both.

$sel:publicTypeArn:ActivateType', activateType_publicTypeArn - The Amazon Resource Name (ARN) of the public extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

ActivateType, activateType_publisherId - The ID of the extension publisher.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

ActivateType, activateType_type - The extension type.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

ActivateType, activateType_typeName - The name of the extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

ActivateType, activateType_typeNameAlias - An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.

$sel:versionBump:ActivateType', activateType_versionBump - Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

• MAJOR: CloudFormation updates the extension to the newest major version, if one is available.
• MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

Request Lenses

activateType_autoUpdate :: Lens' ActivateType (Maybe Bool)

Whether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.

The default is true.

activateType_executionRoleArn :: Lens' ActivateType (Maybe Text)

The name of the IAM execution role to use to activate the extension.

activateType_loggingConfig :: Lens' ActivateType (Maybe LoggingConfig)

Undocumented member.

activateType_majorVersion :: Lens' ActivateType (Maybe Natural)

The major version of this extension you want to activate, if multiple major versions are available. The default is the latest major version. CloudFormation uses the latest available minor version of the major version selected.

You can specify MajorVersion or VersionBump, but not both.

activateType_publicTypeArn :: Lens' ActivateType (Maybe Text)

The Amazon Resource Name (ARN) of the public extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

activateType_publisherId :: Lens' ActivateType (Maybe Text)

The ID of the extension publisher.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

activateType_type :: Lens' ActivateType (Maybe ThirdPartyType)

The extension type.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

activateType_typeName :: Lens' ActivateType (Maybe Text)

The name of the extension.

Conditional: You must specify PublicTypeArn, or TypeName, Type, and PublisherId.

activateType_typeNameAlias :: Lens' ActivateType (Maybe Text)

An alias to assign to the public extension, in this account and region. If you specify an alias for the extension, CloudFormation treats the alias as the extension type name within this account and region. You must use the alias to refer to the extension in your templates, API calls, and CloudFormation console.

An extension alias must be unique within a given account and region. You can activate the same public resource multiple times in the same account and region, using different type name aliases.

activateType_versionBump :: Lens' ActivateType (Maybe VersionBump)

Manually updates a previously-activated type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdate.

• MAJOR: CloudFormation updates the extension to the newest major version, if one is available.
• MINOR: CloudFormation updates the extension to the newest minor version, if one is available.

Destructuring the Response

data ActivateTypeResponse

See: newActivateTypeResponse smart constructor.

Constructors

ActivateTypeResponse'

Fields

• arn :: Maybe Text

  The Amazon Resource Name (ARN) of the activated extension, in this account and region.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ActivateTypeResponse

Defined in Amazonka.CloudFormation.ActivateType

Associated Types

type Rep ActivateTypeResponse :: Type -> Type

Methods

from :: ActivateTypeResponse -> Rep ActivateTypeResponse x

to :: Rep ActivateTypeResponse x -> ActivateTypeResponse

Read ActivateTypeResponse

Defined in Amazonka.CloudFormation.ActivateType

Methods

readsPrec :: Int -> ReadS ActivateTypeResponse

readList :: ReadS [ActivateTypeResponse]

readPrec :: ReadPrec ActivateTypeResponse

readListPrec :: ReadPrec [ActivateTypeResponse]

Show ActivateTypeResponse

Defined in Amazonka.CloudFormation.ActivateType

Methods

showsPrec :: Int -> ActivateTypeResponse -> ShowS

show :: ActivateTypeResponse -> String

showList :: [ActivateTypeResponse] -> ShowS

NFData ActivateTypeResponse

Defined in Amazonka.CloudFormation.ActivateType

Methods

rnf :: ActivateTypeResponse -> ()

Eq ActivateTypeResponse

Defined in Amazonka.CloudFormation.ActivateType

Methods

(==) :: ActivateTypeResponse -> ActivateTypeResponse -> Bool

(/=) :: ActivateTypeResponse -> ActivateTypeResponse -> Bool

type Rep ActivateTypeResponse

Defined in Amazonka.CloudFormation.ActivateType

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

newActivateTypeResponse

Arguments

:: Int

$sel:httpStatus:ActivateTypeResponse'

-> ActivateTypeResponse

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

ActivateTypeResponse, activateTypeResponse_arn - The Amazon Resource Name (ARN) of the activated extension, in this account and region.

$sel:httpStatus:ActivateTypeResponse', activateTypeResponse_httpStatus - The response's http status code.

Response Lenses

activateTypeResponse_arn :: Lens' ActivateTypeResponse (Maybe Text)

The Amazon Resource Name (ARN) of the activated extension, in this account and region.

activateTypeResponse_httpStatus :: Lens' ActivateTypeResponse Int

The response's http status code.