[ aws . cloudformation ]

set-type-default-version

Description

Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  set-type-default-version
[--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 extension for which you want version summary information.

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

--type (string)

The kind of extension.

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

Possible values:

• RESOURCE

• MODULE

• HOOK

--type-name (string)

The name of the extension.

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

--version-id (string)

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.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To set a type’s default version

The following set-type-default-version example sets the specified type version to be used as the default for this type.

aws cloudformation set-type-default-version \
    --type RESOURCE \
    --type-name My::Logs::LogGroup \
    --version-id 00000003

This command produces no output.

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

Output

None