[ aws . cloudformation ]

deregister-type

Description

Removes a type or type version from active use in the CloudFormation registry. If a type or type version is deregistered, it cannot be used in CloudFormation operations.

To deregister a type, you must individually deregister all registered versions of that type. If a type has only a single registered version, deregistering that version results in the type itself being deregistered.

You cannot deregister the default version of a type, unless it is the only registered version of that type, in which case the type itself is deregistered as well.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  deregister-type
[--arn <value>]
[--type <value>]
[--type-name <value>]
[--version-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--arn (string)

The Amazon Resource Name (ARN) of the type.

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

--type (string)

The kind of type.

Currently the only valid value is RESOURCE .

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

Possible values:

  • RESOURCE

  • MODULE

--type-name (string)

The name of the type.

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

--version-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To deregister a type version

The following deregister-type example removes the specified type version from active use in the CloudFormation registry, so that it can no longer be used in CloudFormation operations.

aws cloudformation deregister-type \
    --type RESOURCE \
    --type-name My::Logs::LogGroup \
    --version-id 00000002

This command produces no output.

For more information, see Using the CloudFormation Registry in the AWS CloudFormation Users Guide.

Output

None