SetTypeDefaultVersion - AWS CloudFormation

SetTypeDefaultVersion

Specify the default version of a type. The default version of a type will be used in CloudFormation operations.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Arn

The Amazon Resource Name (ARN) of the type for which you want version summary information.

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

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws[A-Za-z0-9-]{0,64}:cloudformation:[A-Za-z0-9-]{1,64}:[0-9]{12}:type/.+

Required: No

Type

The kind of type.

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

Type: String

Valid Values: RESOURCE

Required: No

TypeName

The name of the type.

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

Type: String

Length Constraints: Minimum length of 10. Maximum length of 196.

Pattern: [A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}::[A-Za-z0-9]{2,64}

Required: No

VersionId

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9-]+

Required: No

Errors

For information about the errors that are common to all actions, see Common Errors.

CFNRegistry

An error occurred during a CloudFormation registry operation.

HTTP Status Code: 400

TypeNotFound

The specified type does not exist in the CloudFormation registry.

HTTP Status Code: 404

Examples

SetTypeDefaultVersion

This example illustrates one usage of SetTypeDefaultVersion.

Sample Request

https://cloudformation.us-east-1.amazonaws.com/ ?Action=SetTypeDefaultVersion &Version=2010-05-15 &TypeName=My::Resource::Example &VersionId=00000003 &Type=RESOURCE &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=[Access key ID and scope] &X-Amz-Date=20191204T182814Z &X-Amz-SignedHeaders=content-type;host &X-Amz-Signature=[Signature]

Sample Response

<SetTypeDefaultVersionResponse xmlns="http://cloudformation.amazonaws.com/doc/2010-05-15/"> <SetTypeDefaultVersionResult/> <ResponseMetadata> <RequestId>dc46ff50-4ab3-485a-a104-bbbd3example</RequestId> </ResponseMetadata> </SetTypeDefaultVersionResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: