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

Description

Marks an extension or extension version as DEPRECATED in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.

To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry.

You can't deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the extension type itself is deregistered as well and marked as deprecated.

To view the deprecation status of an extension or extension version, use DescribeType.

Synopsis

Creating a Request

data DeregisterType Source #

See: newDeregisterType smart constructor.

Constructors

DeregisterType' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the extension.

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

  • type' :: Maybe RegistryType

    The kind of extension.

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

  • typeName :: Maybe Text

    The name of the extension.

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

  • versionId :: Maybe Text

    The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

Instances

Instances details
ToHeaders DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

toHeaders :: DeregisterType -> [Header] #

ToPath DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

toPath :: DeregisterType -> ByteString #

ToQuery DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

toQuery :: DeregisterType -> QueryString #

AWSRequest DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Associated Types

type AWSResponse DeregisterType #

Methods

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

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

Generic DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Associated Types

type Rep DeregisterType :: Type -> Type #

Methods

from :: DeregisterType -> Rep DeregisterType x #

to :: Rep DeregisterType x -> DeregisterType #

Read DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

readsPrec :: Int -> ReadS DeregisterType #

readList :: ReadS [DeregisterType] #

readPrec :: ReadPrec DeregisterType #

readListPrec :: ReadPrec [DeregisterType] #

Show DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

showsPrec :: Int -> DeregisterType -> ShowS #

show :: DeregisterType -> String #

showList :: [DeregisterType] -> ShowS #

NFData DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

rnf :: DeregisterType -> () #

Eq DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

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

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

Hashable DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

hashWithSalt :: Int -> DeregisterType -> Int #

hash :: DeregisterType -> Int #

type AWSResponse DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

type AWSResponse DeregisterType = DeregisterTypeResponse
type Rep DeregisterType Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

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

newDeregisterType :: DeregisterType Source #

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

DeregisterType, deregisterType_arn - The Amazon Resource Name (ARN) of the extension.

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

DeregisterType, deregisterType_type - The kind of extension.

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

DeregisterType, deregisterType_typeName - The name of the extension.

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

DeregisterType, deregisterType_versionId - The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

Request Lenses

deregisterType_arn :: Lens' DeregisterType (Maybe Text) Source #

The Amazon Resource Name (ARN) of the extension.

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

deregisterType_type :: Lens' DeregisterType (Maybe RegistryType) Source #

The kind of extension.

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

deregisterType_typeName :: Lens' DeregisterType (Maybe Text) Source #

The name of the extension.

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

deregisterType_versionId :: Lens' DeregisterType (Maybe Text) Source #

The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

Destructuring the Response

data DeregisterTypeResponse Source #

See: newDeregisterTypeResponse smart constructor.

Constructors

DeregisterTypeResponse' 

Fields

Instances

Instances details
Generic DeregisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Associated Types

type Rep DeregisterTypeResponse :: Type -> Type #

Methods

from :: DeregisterTypeResponse -> Rep DeregisterTypeResponse x #

to :: Rep DeregisterTypeResponse x -> DeregisterTypeResponse #

Read DeregisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

readsPrec :: Int -> ReadS DeregisterTypeResponse #

readList :: ReadS [DeregisterTypeResponse] #

readPrec :: ReadPrec DeregisterTypeResponse #

readListPrec :: ReadPrec [DeregisterTypeResponse] #

Show DeregisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

showsPrec :: Int -> DeregisterTypeResponse -> ShowS #

show :: DeregisterTypeResponse -> String #

showList :: [DeregisterTypeResponse] -> ShowS #

NFData DeregisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

rnf :: DeregisterTypeResponse -> () #

Eq DeregisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

Methods

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

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

type Rep DeregisterTypeResponse Source # 
Instance details

Defined in Amazonka.CloudFormation.DeregisterType

type Rep DeregisterTypeResponse = D1 ('MetaData "DeregisterTypeResponse" "Amazonka.CloudFormation.DeregisterType" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "DeregisterTypeResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDeregisterTypeResponse Source #

Arguments

:: Int

$sel:httpStatus:DeregisterTypeResponse'

-> DeregisterTypeResponse 

Create a value of DeregisterTypeResponse 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:httpStatus:DeregisterTypeResponse', deregisterTypeResponse_httpStatus - The response's http status code.

Response Lenses

deregisterTypeResponse_httpStatus :: Lens' DeregisterTypeResponse Int Source #

The response's http status code.