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 . proton ]

create-service-instance

Description

Create a service instance.

See also: AWS API Documentation

Synopsis

  create-service-instance
[--client-token <value>]
--name <value>
--service-name <value>
--spec <value>
[--tags <value>]
[--template-major-version <value>]
[--template-minor-version <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

--client-token (string)

The client token of the service instance to create.

--name (string)

The name of the service instance to create.

--service-name (string)

The name of the service the service instance is added to.

--spec (string)

The spec for the service instance you want to create.

--tags (list)

An optional list of metadata items that you can associate with the Proton service instance. A tag is a key-value pair.

For more information, see Proton resources and tagging in the Proton User Guide .

(structure)

A description of a resource tag.

key -> (string)

The key of the resource tag.

value -> (string)

The value of the resource tag.

Shorthand Syntax:

key=string,value=string ...

JSON Syntax:

[
  {
    "key": "string",
    "value": "string"
  }
  ...
]

--template-major-version (string)

To create a new major and minor version of the service template, exclude major Version .

--template-minor-version (string)

To create a new minor version of the service template, include a major Version .

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

serviceInstance -> (structure)

The detailed data of the service instance being created.

arn -> (string)

The Amazon Resource Name (ARN) of the service instance.

createdAt -> (timestamp)

The time when the service instance was created.

deploymentStatus -> (string)

The service instance deployment status.

deploymentStatusMessage -> (string)

The message associated with the service instance deployment status.

environmentName -> (string)

The name of the environment that the service instance was deployed into.

lastAttemptedDeploymentId -> (string)

The ID of the last attempted deployment of this service instance.

lastClientRequestToken -> (string)

The last client request token received.

lastDeploymentAttemptedAt -> (timestamp)

The time when a deployment of the service instance was last attempted.

lastDeploymentSucceededAt -> (timestamp)

The time when the service instance was last deployed successfully.

lastSucceededDeploymentId -> (string)

The ID of the last successful deployment of this service instance.

name -> (string)

The name of the service instance.

serviceName -> (string)

The name of the service that the service instance belongs to.

spec -> (string)

The service spec that was used to create the service instance.

templateMajorVersion -> (string)

The major version of the service template that was used to create the service instance.

templateMinorVersion -> (string)

The minor version of the service template that was used to create the service instance.

templateName -> (string)

The name of the service template that was used to create the service instance.