Class: Aws::ServiceCatalog::Types::CreateConstraintInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::ServiceCatalog::Types::CreateConstraintInput
- Defined in:
- gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb
Overview
When making an API call, you may pass CreateConstraintInput data as a hash:
{
accept_language: "AcceptLanguage",
portfolio_id: "Id", # required
product_id: "Id", # required
parameters: "ConstraintParameters", # required
type: "ConstraintType", # required
description: "ConstraintDescription",
idempotency_token: "IdempotencyToken", # required
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#accept_language ⇒ String
The language code.
-
#description ⇒ String
The description of the constraint.
-
#idempotency_token ⇒ String
A unique identifier that you provide to ensure idempotency.
-
#parameters ⇒ String
The constraint parameters, in JSON format.
-
#portfolio_id ⇒ String
The portfolio identifier.
-
#product_id ⇒ String
The product identifier.
-
#type ⇒ String
The type of constraint.
Instance Attribute Details
#accept_language ⇒ String
The language code.
en
- English (default)jp
- Japanesezh
- Chinese
734 735 736 737 738 739 740 741 742 743 744 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 734 class CreateConstraintInput < Struct.new( :accept_language, :portfolio_id, :product_id, :parameters, :type, :description, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the constraint.
734 735 736 737 738 739 740 741 742 743 744 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 734 class CreateConstraintInput < Struct.new( :accept_language, :portfolio_id, :product_id, :parameters, :type, :description, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#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.
A suitable default value is auto-generated. You should normally not need to pass this option.
734 735 736 737 738 739 740 741 742 743 744 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 734 class CreateConstraintInput < Struct.new( :accept_language, :portfolio_id, :product_id, :parameters, :type, :description, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#parameters ⇒ String
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 theLocalRoleName
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 aSTACKSET
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 ofALLOWED
orNOT_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 aSTACKSET
constraint.You also cannot have more than one
STACKSET
constraint on a product and portfolio.Products with a
STACKSET
constraint will launch an AWS CloudFormation stack set.- TEMPLATE
Specify the
Rules
property. For more information, see Template Constraint Rules.
734 735 736 737 738 739 740 741 742 743 744 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 734 class CreateConstraintInput < Struct.new( :accept_language, :portfolio_id, :product_id, :parameters, :type, :description, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#portfolio_id ⇒ String
The portfolio identifier.
734 735 736 737 738 739 740 741 742 743 744 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 734 class CreateConstraintInput < Struct.new( :accept_language, :portfolio_id, :product_id, :parameters, :type, :description, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#product_id ⇒ String
The product identifier.
734 735 736 737 738 739 740 741 742 743 744 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 734 class CreateConstraintInput < Struct.new( :accept_language, :portfolio_id, :product_id, :parameters, :type, :description, :idempotency_token) SENSITIVE = [] include Aws::Structure end |
#type ⇒ String
The type of constraint.
LAUNCH
NOTIFICATION
RESOURCE_UPDATE
STACKSET
TEMPLATE
734 735 736 737 738 739 740 741 742 743 744 |
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 734 class CreateConstraintInput < Struct.new( :accept_language, :portfolio_id, :product_id, :parameters, :type, :description, :idempotency_token) SENSITIVE = [] include Aws::Structure end |