Class: AWSCDK::ServiceCatalog::StackSetsConstraintOptions

Inherits:
CommonConstraintOptions
  • Object
show all
Defined in:
service_catalog/stack_sets_constraint_options.rb

Overview

Properties for deploying with Stackset, which creates a StackSet constraint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, message_language: nil, accounts:, admin_role:, execution_role_name:, regions:, allow_stack_set_instance_operations: nil) ⇒ StackSetsConstraintOptions

Returns a new instance of StackSetsConstraintOptions.

Parameters:

  • description (String, nil) (defaults to: nil) —

    The description of the constraint.

  • message_language (AWSCDK::ServiceCatalog::MessageLanguage, nil) (defaults to: nil) —

    The language code.

  • accounts (Array<String>) —

    List of accounts to deploy stacks to.

  • admin_role (AWSCDK::Interfaces::AWSIAM::IRoleRef) —

    IAM role used to administer the StackSets configuration.

  • execution_role_name (String) —

    IAM role used to provision the products in the Stacks.

  • regions (Array<String>) —

    List of regions to deploy stacks to.

  • allow_stack_set_instance_operations (Boolean, nil) (defaults to: nil) —

    Whether to allow end users to create, update, and delete stacks.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 14

def initialize(description: nil, message_language: nil, accounts:, admin_role:, execution_role_name:, regions:, allow_stack_set_instance_operations: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @message_language = message_language
  Jsii::Type.check_type(@message_language, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VydmljZWNhdGFsb2cuTWVzc2FnZUxhbmd1YWdlIn0=")), "messageLanguage") unless @message_language.nil?
  @accounts = accounts
  Jsii::Type.check_type(@accounts, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "accounts")
  @admin_role = admin_role
  Jsii::Type.check_type(@admin_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifQ==")), "adminRole")
  @execution_role_name = execution_role_name
  Jsii::Type.check_type(@execution_role_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleName")
  @regions = regions
  Jsii::Type.check_type(@regions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "regions")
  @allow_stack_set_instance_operations = allow_stack_set_instance_operations
  Jsii::Type.check_type(@allow_stack_set_instance_operations, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "allowStackSetInstanceOperations") unless @allow_stack_set_instance_operations.nil?
end

Instance Attribute Details

#accounts ⇒ Array<String> (readonly)

List of accounts to deploy stacks to.

Returns:

  • (Array<String>) 


46
47
48
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 46

def accounts
  @accounts
end

#admin_role ⇒ AWSCDK::Interfaces::AWSIAM::IRoleRef (readonly)

IAM role used to administer the StackSets configuration.

Returns:



50
51
52
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 50

def admin_role
  @admin_role
end

#allow_stack_set_instance_operations ⇒ Boolean? (readonly)

Note:

Default: false

Whether to allow end users to create, update, and delete stacks.

Returns:

  • (Boolean, nil) 


63
64
65
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 63

def allow_stack_set_instance_operations
  @allow_stack_set_instance_operations
end

#description ⇒ String? (readonly)

Note:

Default: - No description provided

The description of the constraint.

Returns:

  • (String, nil) 


35
36
37
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 35

def description
  @description
end

#execution_role_name ⇒ String (readonly)

IAM role used to provision the products in the Stacks.

Returns:

  • (String) 


54
55
56
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 54

def execution_role_name
  @execution_role_name
end

#message_language ⇒ AWSCDK::ServiceCatalog::MessageLanguage? (readonly)

Note:

Default: - English

The language code.

Configures the language for error messages from service catalog.

Returns:



42
43
44
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 42

def message_language
  @message_language
end

#regions ⇒ Array<String> (readonly)

List of regions to deploy stacks to.

Returns:

  • (Array<String>) 


58
59
60
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 58

def regions
  @regions
end

Class Method Details

.jsii_properties ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 65

def self.jsii_properties
  {
    :description => "description",
    :message_language => "messageLanguage",
    :accounts => "accounts",
    :admin_role => "adminRole",
    :execution_role_name => "executionRoleName",
    :regions => "regions",
    :allow_stack_set_instance_operations => "allowStackSetInstanceOperations",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'service_catalog/stack_sets_constraint_options.rb', line 77

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "description" => @description,
    "messageLanguage" => @message_language,
    "accounts" => @accounts,
    "adminRole" => @admin_role,
    "executionRoleName" => @execution_role_name,
    "regions" => @regions,
    "allowStackSetInstanceOperations" => @allow_stack_set_instance_operations,
  })
  result.compact
end