Class: Aws::ServiceCatalog::Types::CreateConstraintInput

Inherits:

Struct

• Object
• Struct
• Aws::ServiceCatalog::Types::CreateConstraintInput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-servicecatalog/types.rb

Overview

Note:

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
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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` - Japanese

• ‘zh` - Chinese

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 630

class CreateConstraintInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :product_id,
  :parameters,
  :type,
  :description,
  :idempotency_token)
  include Aws::Structure
end

#description ⇒ String

The description of the constraint.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 630

class CreateConstraintInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :product_id,
  :parameters,
  :type,
  :description,
  :idempotency_token)
  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.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 630

class CreateConstraintInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :product_id,
  :parameters,
  :type,
  :description,
  :idempotency_token)
  include Aws::Structure
end

#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"\}`

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"]\}`

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 AWS
CloudFormation stack set.

TEMPLATE

: Specify the ‘Rules` property. For more information, see [Template

Constraint Rules][1].

[1]: docs.aws.amazon.com/servicecatalog/latest/adminguide/reference-template_constraint_rules.html

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 630

class CreateConstraintInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :product_id,
  :parameters,
  :type,
  :description,
  :idempotency_token)
  include Aws::Structure
end

#portfolio_id ⇒ String

The portfolio identifier.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 630

class CreateConstraintInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :product_id,
  :parameters,
  :type,
  :description,
  :idempotency_token)
  include Aws::Structure
end

#product_id ⇒ String

The product identifier.

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 630

class CreateConstraintInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :product_id,
  :parameters,
  :type,
  :description,
  :idempotency_token)
  include Aws::Structure
end

#type ⇒ String

The type of constraint.

• ‘LAUNCH`

• ‘NOTIFICATION`

• ‘STACKSET`

• ‘TEMPLATE`

Returns:

• (String)

# File 'lib/aws-sdk-servicecatalog/types.rb', line 630

class CreateConstraintInput < Struct.new(
  :accept_language,
  :portfolio_id,
  :product_id,
  :parameters,
  :type,
  :description,
  :idempotency_token)
  include Aws::Structure
end