Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . cloudformation ]

create-generated-template

Description

Creates a template from existing resources that are not already managed with CloudFormation. You can check the status of the template generation using the DescribeGeneratedTemplate API action.

See also: AWS API Documentation

Synopsis

  create-generated-template
[--resources <value>]
--generated-template-name <value>
[--stack-name <value>]
[--template-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--resources (list)

An optional list of resources to be included in the generated template.

If no resources are specified,the template will be created without any resources. Resources can be added to the template using the UpdateGeneratedTemplate API action.

(structure)

A resource included in a generated template. This data type is used with the CreateGeneratedTemplate and UpdateGeneratedTemplate API actions.

ResourceType -> (string)

The type of the resource, such as AWS::DynamoDB::Table . For the list of supported resources, see IaC generator supported resource types in the CloudFormation User Guide

LogicalResourceId -> (string)

The logical resource id for this resource in the generated template.

ResourceIdentifier -> (map)

A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable" . For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development .

key -> (string)

value -> (string)

Shorthand Syntax:

ResourceType=string,LogicalResourceId=string,ResourceIdentifier={KeyName1=string,KeyName2=string} ...

JSON Syntax:

[
  {
    "ResourceType": "string",
    "LogicalResourceId": "string",
    "ResourceIdentifier": {"string": "string"
      ...}
  }
  ...
]

--generated-template-name (string)

The name assigned to the generated template.

--stack-name (string)

An optional name or ARN of a stack to use as the base stack for the generated template.

--template-configuration (structure)

The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy .

DeletionPolicy -> (string)

The DeletionPolicy assigned to resources in the generated template. Supported values are:

  • DELETE - delete all resources when the stack is deleted.
  • RETAIN - retain all resources when the stack is deleted.

For more information, see DeletionPolicy attribute in the CloudFormation User Guide .

UpdateReplacePolicy -> (string)

The UpdateReplacePolicy assigned to resources in the generated template. Supported values are:

  • DELETE - delete all resources when the resource is replaced during an update operation.
  • RETAIN - retain all resources when the resource is replaced during an update operation.

For more information, see UpdateReplacePolicy attribute in the CloudFormation User Guide .

Shorthand Syntax:

DeletionPolicy=string,UpdateReplacePolicy=string

JSON Syntax:

{
  "DeletionPolicy": "DELETE"|"RETAIN",
  "UpdateReplacePolicy": "DELETE"|"RETAIN"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

GeneratedTemplateId -> (string)

The ID of the generated template.