Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . servicecatalog ]

create-constraint

Description

Creates a constraint.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-constraint
[--accept-language <value>]
--portfolio-id <value>
--product-id <value>
--parameters <value>
--type <value>
[--description <value>]
[--idempotency-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--accept-language (string)

The language code.

  • en - English (default)
  • jp - Japanese
  • zh - Chinese

--portfolio-id (string)

The portfolio identifier.

--product-id (string)

The product identifier.

--parameters (string)

The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:

LAUNCH

Specify the RoleArn property as follows:

"RoleArn" : "arn:aws:iam::123456789012:role/LaunchRole"

NOTIFICATION

Specify the NotificationArns property as follows:

"NotificationArns" : ["arn:aws:sns:us-east-1:123456789012:Topic"]

TEMPLATE

Specify the Rules property. For more information, see Template Constraint Rules .

--type (string)

The type of constraint.

  • LAUNCH
  • NOTIFICATION
  • TEMPLATE

--description (string)

The description of the constraint.

--idempotency-token (string)

A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.

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

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

See 'aws help' for descriptions of global parameters.

Output

ConstraintDetail -> (structure)

Information about the constraint.

ConstraintId -> (string)

The identifier of the constraint.

Type -> (string)

The type of constraint.

  • LAUNCH
  • NOTIFICATION
  • TEMPLATE

Description -> (string)

The description of the constraint.

Owner -> (string)

The owner of the constraint.

ConstraintParameters -> (string)

The constraint parameters.

Status -> (string)

The status of the current request.