Skip to content

Create Constraint

servicecatalog_create_constraint R Documentation

Creates a constraint

Description

Creates a constraint.

A delegated admin is authorized to invoke this command.

Usage

servicecatalog_create_constraint(AcceptLanguage, PortfolioId, ProductId,
  Parameters, Type, Description, IdempotencyToken)

Arguments

AcceptLanguage

The language code.

  • jp - Japanese

  • zh - Chinese

PortfolioId

[required] The portfolio identifier.

ProductId

[required] The product identifier.

Parameters

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

LAUNCH

You are required to specify either the RoleArn or the LocalRoleName but can't use both.

Specify the RoleArn property as follows:

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

Specify the LocalRoleName property as follows:

{"LocalRoleName": "SCBasicLaunchRole"}

If you specify the LocalRoleName property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be account-agnostic so the administrator can create fewer resources per shared account.

The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one LAUNCH constraint on a product and portfolio.

NOTIFICATION

Specify the NotificationArns property as follows:

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

RESOURCE_UPDATE

Specify the TagUpdatesOnProvisionedProduct property as follows:

⁠{"Version":"2.0","Properties":{"TagUpdateOnProvisionedProduct":"String"}}⁠

The TagUpdatesOnProvisionedProduct property accepts a string value of ALLOWED or NOT_ALLOWED.

STACKSET

Specify the Parameters property as follows:

⁠{"Version": "String", "Properties": {"AccountList": [ "String" ], "RegionList": [ "String" ], "AdminRole": "String", "ExecutionRole": "String"}}⁠

You cannot have both a LAUNCH and a STACKSET constraint.

You also cannot have more than one STACKSET constraint on a product and portfolio.

Products with a STACKSET constraint will launch an CloudFormation stack set.

TEMPLATE

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

Type

[required] The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Description

The description of the constraint.

IdempotencyToken

[required] 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.

Value

A list with the following syntax: 

list(
  ConstraintDetail = list(
    ConstraintId = "string",
    Type = "string",
    Description = "string",
    Owner = "string",
    ProductId = "string",
    PortfolioId = "string"
  ),
  ConstraintParameters = "string",
  Status = "AVAILABLE"|"CREATING"|"FAILED"
)

Request syntax

svc$create_constraint(
  AcceptLanguage = "string",
  PortfolioId = "string",
  ProductId = "string",
  Parameters = "string",
  Type = "string",
  Description = "string",
  IdempotencyToken = "string"
)