AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateConstraint operation. Creates a constraint.

A delegated admin is authorized to invoke this command.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.ServiceCatalog.AmazonServiceCatalogRequest
      Amazon.ServiceCatalog.Model.CreateConstraintRequest

Namespace: Amazon.ServiceCatalog.Model
Assembly: AWSSDK.ServiceCatalog.dll
Version: 3.x.y.z

Syntax

C#
public class CreateConstraintRequest : AmazonServiceCatalogRequest
         IAmazonWebServiceRequest

The CreateConstraintRequest type exposes the following members

Constructors

NameDescription
Public Method CreateConstraintRequest()

Properties

NameTypeDescription
Public Property AcceptLanguage System.String

Gets and sets the property AcceptLanguage.

The language code.

  • jp - Japanese

  • zh - Chinese

Public Property Description System.String

Gets and sets the property Description.

The description of the constraint.

Public Property IdempotencyToken System.String

Gets and sets the property IdempotencyToken.

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.

Public Property Parameters System.String

Gets and sets the property Parameters.

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.

Public Property PortfolioId System.String

Gets and sets the property PortfolioId.

The portfolio identifier.

Public Property ProductId System.String

Gets and sets the property ProductId.

The product identifier.

Public Property Type System.String

Gets and sets the property Type.

The type of constraint.

  • LAUNCH

  • NOTIFICATION

  • RESOURCE_UPDATE

  • STACKSET

  • TEMPLATE

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5