You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-servicecatalog/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
}

Instance Attribute Summary collapse

Instance Attribute Details

#accept_languageString

The language code to use for this operation. Supported language codes are as follows:

"en" (English)

"jp" (Japanese)

"zh" (Chinese)

If no code is specified, "en" is used as the default.

Returns:

  • (String)


321
322
323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 321

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

#descriptionString

The text description of the constraint.

Returns:

  • (String)


321
322
323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 321

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

#idempotency_tokenString

A token to disambiguate duplicate requests. You can create multiple resources using the same input in multiple requests, provided that you also specify a different idempotency token for each request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


321
322
323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 321

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

#parametersString

The constraint parameters. Expected values vary depending on which Type is specified. For examples, see the bottom of this topic.

For Type LAUNCH, the RoleArn property is required.

For Type NOTIFICATION, the NotificationArns property is required.

For Type TEMPLATE, the Rules property is required.

Returns:

  • (String)


321
322
323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 321

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

#portfolio_idString

The portfolio identifier.

Returns:

  • (String)


321
322
323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 321

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

#product_idString

The product identifier.

Returns:

  • (String)


321
322
323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 321

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

#typeString

The type of the constraint. Case-sensitive valid values are: LAUNCH, NOTIFICATION, or TEMPLATE.

Returns:

  • (String)


321
322
323
324
325
326
327
328
329
330
# File 'gems/aws-sdk-servicecatalog/lib/aws-sdk-servicecatalog/types.rb', line 321

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