Class: AWSCDK::OpsWorks::CfnStack

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSOpsworks::IStackRef
Defined in:
ops_works/cfn_stack.rb

Overview

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnStack

Create a new AWS::OpsWorks::Stack.

Parameters:

  • scope (Constructs::Construct)

    Scope in which this resource is defined.

  • id (String)

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::OpsWorks::CfnStackProps)

    Resource properties.



18
19
20
21
22
23
24
# File 'ops_works/cfn_stack.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::OpsWorks::CfnStackProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3Bzd29ya3MuQ2ZuU3RhY2tQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_stack(resource) ⇒ String

Parameters:

Returns:

  • (String)


96
97
98
99
# File 'ops_works/cfn_stack.rb', line 96

def self.arn_for_stack(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19vcHN3b3Jrcy5JU3RhY2tSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opsworks.CfnStack", "arnForStack", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


216
217
218
# File 'ops_works/cfn_stack.rb', line 216

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_opsworks.CfnStack", "CFN_RESOURCE_TYPE_NAME")
end

.from_stack_id(scope, id, stack_id) ⇒ AWSCDK::Interfaces::AWSOpsworks::IStackRef

Creates a new IStackRef from a stackId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • stack_id (String)

Returns:



107
108
109
110
111
112
# File 'ops_works/cfn_stack.rb', line 107

def self.from_stack_id(scope, id, stack_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(stack_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stackId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opsworks.CfnStack", "fromStackId", [scope, id, stack_id])
end

.is_cfn_stack(x) ⇒ Boolean

Checks whether the given object is a CfnStack.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


118
119
120
121
# File 'ops_works/cfn_stack.rb', line 118

def self.is_cfn_stack(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_opsworks.CfnStack", "isCfnStack", [x])
end

.jsii_overridable_methodsObject



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'ops_works/cfn_stack.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :stack_ref => { kind: :property, name: "stackRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :custom_json => { kind: :property, name: "customJson", is_optional: false },
    :default_instance_profile_arn => { kind: :property, name: "defaultInstanceProfileArn", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :service_role_arn => { kind: :property, name: "serviceRoleArn", is_optional: false },
    :agent_version => { kind: :property, name: "agentVersion", is_optional: true },
    :attributes => { kind: :property, name: "attributes", is_optional: true },
    :chef_configuration => { kind: :property, name: "chefConfiguration", is_optional: true },
    :clone_app_ids => { kind: :property, name: "cloneAppIds", is_optional: true },
    :clone_permissions => { kind: :property, name: "clonePermissions", is_optional: true },
    :configuration_manager => { kind: :property, name: "configurationManager", is_optional: true },
    :custom_cookbooks_source => { kind: :property, name: "customCookbooksSource", is_optional: true },
    :default_availability_zone => { kind: :property, name: "defaultAvailabilityZone", is_optional: true },
    :default_os => { kind: :property, name: "defaultOs", is_optional: true },
    :default_root_device_type => { kind: :property, name: "defaultRootDeviceType", is_optional: true },
    :default_ssh_key_name => { kind: :property, name: "defaultSshKeyName", is_optional: true },
    :default_subnet_id => { kind: :property, name: "defaultSubnetId", is_optional: true },
    :ecs_cluster_arn => { kind: :property, name: "ecsClusterArn", is_optional: true },
    :elastic_ips => { kind: :property, name: "elasticIps", is_optional: true },
    :hostname_theme => { kind: :property, name: "hostnameTheme", is_optional: true },
    :rds_db_instances => { kind: :property, name: "rdsDbInstances", is_optional: true },
    :source_stack_id => { kind: :property, name: "sourceStackId", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :use_custom_cookbooks => { kind: :property, name: "useCustomCookbooks", is_optional: true },
    :use_opsworks_security_groups => { kind: :property, name: "useOpsworksSecurityGroups", is_optional: true },
    :vpc_id => { kind: :property, name: "vpcId", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String)

    The path of the value to delete.



581
582
583
584
# File 'ops_works/cfn_stack.rb', line 581

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



593
594
595
596
# File 'ops_works/cfn_stack.rb', line 593

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



603
604
605
606
# File 'ops_works/cfn_stack.rb', line 603

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.



614
615
616
617
618
# File 'ops_works/cfn_stack.rb', line 614

def (key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String)
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object)
    • The value.


671
672
673
674
675
# File 'ops_works/cfn_stack.rb', line 671

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String)

    The path to the property.



681
682
683
684
# File 'ops_works/cfn_stack.rb', line 681

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String)

    The path of the property.

  • value (Object)

    The value.



693
694
695
696
697
# File 'ops_works/cfn_stack.rb', line 693

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#agent_versionString?

The default OpsWorks Stacks agent version.

You have the following options:.

Returns:

  • (String, nil)


292
293
294
# File 'ops_works/cfn_stack.rb', line 292

def agent_version()
  jsii_get_property("agentVersion")
end

#agent_version=(value) ⇒ Object



296
297
298
299
# File 'ops_works/cfn_stack.rb', line 296

def agent_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "agentVersion") unless value.nil?
  jsii_set_property("agentVersion", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



706
707
708
709
# File 'ops_works/cfn_stack.rb', line 706

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:



728
729
730
731
732
733
# File 'ops_works/cfn_stack.rb', line 728

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_idString

Returns:

  • (String)


221
222
223
# File 'ops_works/cfn_stack.rb', line 221

def attr_id()
  jsii_get_property("attrId")
end

#attributesAWSCDK::IResolvable, ...

One or more user-defined key-value pairs to be added to the stack attributes.

Returns:



304
305
306
# File 'ops_works/cfn_stack.rb', line 304

def attributes()
  jsii_get_property("attributes")
end

#attributes=(value) ⇒ Object



308
309
310
311
# File 'ops_works/cfn_stack.rb', line 308

def attributes=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "attributes") unless value.nil?
  jsii_set_property("attributes", value)
end

#cfn_optionsAWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.



169
170
171
# File 'ops_works/cfn_stack.rb', line 169

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


174
175
176
# File 'ops_works/cfn_stack.rb', line 174

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


737
738
739
740
# File 'ops_works/cfn_stack.rb', line 737

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_namesHash{String => String}

Returns:

  • (Hash{String => String})


179
180
181
# File 'ops_works/cfn_stack.rb', line 179

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


186
187
188
# File 'ops_works/cfn_stack.rb', line 186

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#chef_configurationAWSCDK::IResolvable, ...

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack .



316
317
318
# File 'ops_works/cfn_stack.rb', line 316

def chef_configuration()
  jsii_get_property("chefConfiguration")
end

#chef_configuration=(value) ⇒ Object



320
321
322
323
324
# File 'ops_works/cfn_stack.rb', line 320

def chef_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpsWorks::CfnStack::ChefConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcHN3b3Jrcy5DZm5TdGFjay5DaGVmQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "chefConfiguration") unless value.nil?
  jsii_set_property("chefConfiguration", value)
end

#clone_app_idsArray<String>?

If you're cloning an OpsWorks stack, a list of OpsWorks application stack IDs from the source stack to include in the cloned stack.

Returns:

  • (Array<String>, nil)


329
330
331
# File 'ops_works/cfn_stack.rb', line 329

def clone_app_ids()
  jsii_get_property("cloneAppIds")
end

#clone_app_ids=(value) ⇒ Object



333
334
335
336
# File 'ops_works/cfn_stack.rb', line 333

def clone_app_ids=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "cloneAppIds") unless value.nil?
  jsii_set_property("cloneAppIds", value)
end

#clone_permissionsBoolean, ...

If you're cloning an OpsWorks stack, indicates whether to clone the source stack's permissions.

Returns:



341
342
343
# File 'ops_works/cfn_stack.rb', line 341

def clone_permissions()
  jsii_get_property("clonePermissions")
end

#clone_permissions=(value) ⇒ Object



345
346
347
348
# File 'ops_works/cfn_stack.rb', line 345

def clone_permissions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "clonePermissions") unless value.nil?
  jsii_set_property("clonePermissions", value)
end

#configuration_managerAWSCDK::IResolvable, ...

The configuration manager.



353
354
355
# File 'ops_works/cfn_stack.rb', line 353

def configuration_manager()
  jsii_get_property("configurationManager")
end

#configuration_manager=(value) ⇒ Object



357
358
359
360
361
# File 'ops_works/cfn_stack.rb', line 357

def configuration_manager=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpsWorks::CfnStack::StackConfigurationManagerProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcHN3b3Jrcy5DZm5TdGFjay5TdGFja0NvbmZpZ3VyYXRpb25NYW5hZ2VyUHJvcGVydHkifV19fQ==")), "configurationManager") unless value.nil?
  jsii_set_property("configurationManager", value)
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


131
132
133
# File 'ops_works/cfn_stack.rb', line 131

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_cookbooks_sourceAWSCDK::IResolvable, ...

Contains the information required to retrieve an app or cookbook from a repository.



366
367
368
# File 'ops_works/cfn_stack.rb', line 366

def custom_cookbooks_source()
  jsii_get_property("customCookbooksSource")
end

#custom_cookbooks_source=(value) ⇒ Object



370
371
372
373
374
# File 'ops_works/cfn_stack.rb', line 370

def custom_cookbooks_source=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::OpsWorks::CfnStack::SourceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19vcHN3b3Jrcy5DZm5TdGFjay5Tb3VyY2VQcm9wZXJ0eSJ9XX19")), "customCookbooksSource") unless value.nil?
  jsii_set_property("customCookbooksSource", value)
end

#custom_jsonObject

A string that contains user-defined, custom JSON.

Returns:

  • (Object)


242
243
244
# File 'ops_works/cfn_stack.rb', line 242

def custom_json()
  jsii_get_property("customJson")
end

#custom_json=(value) ⇒ Object



246
247
248
249
# File 'ops_works/cfn_stack.rb', line 246

def custom_json=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "customJson")
  jsii_set_property("customJson", value)
end

#default_availability_zoneString?

The stack's default Availability Zone, which must be in the specified region.

Returns:

  • (String, nil)


379
380
381
# File 'ops_works/cfn_stack.rb', line 379

def default_availability_zone()
  jsii_get_property("defaultAvailabilityZone")
end

#default_availability_zone=(value) ⇒ Object



383
384
385
386
# File 'ops_works/cfn_stack.rb', line 383

def default_availability_zone=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultAvailabilityZone") unless value.nil?
  jsii_set_property("defaultAvailabilityZone", value)
end

#default_instance_profile_arnString

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.

Returns:

  • (String)


254
255
256
# File 'ops_works/cfn_stack.rb', line 254

def default_instance_profile_arn()
  jsii_get_property("defaultInstanceProfileArn")
end

#default_instance_profile_arn=(value) ⇒ Object



258
259
260
261
# File 'ops_works/cfn_stack.rb', line 258

def default_instance_profile_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultInstanceProfileArn")
  jsii_set_property("defaultInstanceProfileArn", value)
end

#default_osString?

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.

Returns:

  • (String, nil)


391
392
393
# File 'ops_works/cfn_stack.rb', line 391

def default_os()
  jsii_get_property("defaultOs")
end

#default_os=(value) ⇒ Object



395
396
397
398
# File 'ops_works/cfn_stack.rb', line 395

def default_os=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultOs") unless value.nil?
  jsii_set_property("defaultOs", value)
end

#default_root_device_typeString?

The default root device type.

Returns:

  • (String, nil)


403
404
405
# File 'ops_works/cfn_stack.rb', line 403

def default_root_device_type()
  jsii_get_property("defaultRootDeviceType")
end

#default_root_device_type=(value) ⇒ Object



407
408
409
410
# File 'ops_works/cfn_stack.rb', line 407

def default_root_device_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultRootDeviceType") unless value.nil?
  jsii_set_property("defaultRootDeviceType", value)
end

#default_ssh_key_nameString?

A default Amazon EC2 key pair name.

Returns:

  • (String, nil)


415
416
417
# File 'ops_works/cfn_stack.rb', line 415

def default_ssh_key_name()
  jsii_get_property("defaultSshKeyName")
end

#default_ssh_key_name=(value) ⇒ Object



419
420
421
422
# File 'ops_works/cfn_stack.rb', line 419

def default_ssh_key_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultSshKeyName") unless value.nil?
  jsii_set_property("defaultSshKeyName", value)
end

#default_subnet_idString?

The stack's default subnet ID.

Returns:

  • (String, nil)


427
428
429
# File 'ops_works/cfn_stack.rb', line 427

def default_subnet_id()
  jsii_get_property("defaultSubnetId")
end

#default_subnet_id=(value) ⇒ Object



431
432
433
434
# File 'ops_works/cfn_stack.rb', line 431

def default_subnet_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultSubnetId") unless value.nil?
  jsii_set_property("defaultSubnetId", value)
end

#ecs_cluster_arnString?

The Amazon Resource Name (ARN) of the ( Amazon ECS ) cluster to register with the OpsWorks stack.

Returns:

  • (String, nil)


439
440
441
# File 'ops_works/cfn_stack.rb', line 439

def ecs_cluster_arn()
  jsii_get_property("ecsClusterArn")
end

#ecs_cluster_arn=(value) ⇒ Object



443
444
445
446
# File 'ops_works/cfn_stack.rb', line 443

def ecs_cluster_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ecsClusterArn") unless value.nil?
  jsii_set_property("ecsClusterArn", value)
end

#elastic_ipsAWSCDK::IResolvable, ...

A list of Elastic IP addresses to register with the OpsWorks stack.



451
452
453
# File 'ops_works/cfn_stack.rb', line 451

def elastic_ips()
  jsii_get_property("elasticIps")
end

#elastic_ips=(value) ⇒ Object



455
456
457
458
# File 'ops_works/cfn_stack.rb', line 455

def elastic_ips=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3Bzd29ya3MuQ2ZuU3RhY2suRWxhc3RpY0lwUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "elasticIps") unless value.nil?
  jsii_set_property("elasticIps", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



191
192
193
# File 'ops_works/cfn_stack.rb', line 191

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



750
751
752
753
754
# File 'ops_works/cfn_stack.rb', line 750

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.



761
762
763
764
# File 'ops_works/cfn_stack.rb', line 761

def (key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#hostname_themeString?

The stack's host name theme, with spaces replaced by underscores.

Returns:

  • (String, nil)


463
464
465
# File 'ops_works/cfn_stack.rb', line 463

def hostname_theme()
  jsii_get_property("hostnameTheme")
end

#hostname_theme=(value) ⇒ Object



467
468
469
470
# File 'ops_works/cfn_stack.rb', line 467

def hostname_theme=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hostnameTheme") unless value.nil?
  jsii_set_property("hostnameTheme", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



831
832
833
834
# File 'ops_works/cfn_stack.rb', line 831

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_idString

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String)


143
144
145
# File 'ops_works/cfn_stack.rb', line 143

def logical_id()
  jsii_get_property("logicalId")
end

#nameString

The stack name.

Returns:

  • (String)


266
267
268
# File 'ops_works/cfn_stack.rb', line 266

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object



270
271
272
273
# File 'ops_works/cfn_stack.rb', line 270

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


126
127
128
# File 'ops_works/cfn_stack.rb', line 126

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



772
773
774
# File 'ops_works/cfn_stack.rb', line 772

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



779
780
781
# File 'ops_works/cfn_stack.rb', line 779

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String)

    The new logical ID to use for this stack element.



572
573
574
575
# File 'ops_works/cfn_stack.rb', line 572

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#rds_db_instancesAWSCDK::IResolvable, ...

The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the OpsWorks stack.



475
476
477
# File 'ops_works/cfn_stack.rb', line 475

def rds_db_instances()
  jsii_get_property("rdsDbInstances")
end

#rds_db_instances=(value) ⇒ Object



479
480
481
482
# File 'ops_works/cfn_stack.rb', line 479

def rds_db_instances=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfb3Bzd29ya3MuQ2ZuU3RhY2suUmRzRGJJbnN0YW5jZVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "rdsDbInstances") unless value.nil?
  jsii_set_property("rdsDbInstances", value)
end

#refString

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String)


162
163
164
# File 'ops_works/cfn_stack.rb', line 162

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



790
791
792
793
# File 'ops_works/cfn_stack.rb', line 790

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object})


797
798
799
800
# File 'ops_works/cfn_stack.rb', line 797

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



807
808
809
810
811
# File 'ops_works/cfn_stack.rb', line 807

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#service_role_arnString

The stack's IAM role, which allows OpsWorks Stacks to work with AWS resources on your behalf.

Returns:

  • (String)


278
279
280
# File 'ops_works/cfn_stack.rb', line 278

def service_role_arn()
  jsii_get_property("serviceRoleArn")
end

#service_role_arn=(value) ⇒ Object



282
283
284
285
# File 'ops_works/cfn_stack.rb', line 282

def service_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceRoleArn")
  jsii_set_property("serviceRoleArn", value)
end

#should_synthesizeBoolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean)

    true if the resource should be included or false is the resource should be omitted.



816
817
818
# File 'ops_works/cfn_stack.rb', line 816

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source_stack_idString?

If you're cloning an OpsWorks stack, the stack ID of the source OpsWorks stack to clone.

Returns:

  • (String, nil)


487
488
489
# File 'ops_works/cfn_stack.rb', line 487

def source_stack_id()
  jsii_get_property("sourceStackId")
end

#source_stack_id=(value) ⇒ Object



491
492
493
494
# File 'ops_works/cfn_stack.rb', line 491

def source_stack_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceStackId") unless value.nil?
  jsii_set_property("sourceStackId", value)
end

#stackAWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



152
153
154
# File 'ops_works/cfn_stack.rb', line 152

def stack()
  jsii_get_property("stack")
end

#stack_refAWSCDK::Interfaces::AWSOpsworks::StackReference

A reference to a Stack resource.



228
229
230
# File 'ops_works/cfn_stack.rb', line 228

def stack_ref()
  jsii_get_property("stackRef")
end

#tagsAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



235
236
237
# File 'ops_works/cfn_stack.rb', line 235

def tags()
  jsii_get_property("tags")
end

#tags_rawArray<AWSCDK::CfnTag>?

A map that contains tag keys and tag values that are attached to a stack or layer.

Returns:



499
500
501
# File 'ops_works/cfn_stack.rb', line 499

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object



503
504
505
506
507
# File 'ops_works/cfn_stack.rb', line 503

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



548
549
550
# File 'ops_works/cfn_stack.rb', line 548

def to_string()
  jsii_call_method("toString", [])
end

#updated_properitesHash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object})


199
200
201
# File 'ops_works/cfn_stack.rb', line 199

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object})


209
210
211
# File 'ops_works/cfn_stack.rb', line 209

def updated_properties()
  jsii_get_property("updatedProperties")
end

#use_custom_cookbooksBoolean, ...

Whether the stack uses custom cookbooks.

Returns:



512
513
514
# File 'ops_works/cfn_stack.rb', line 512

def use_custom_cookbooks()
  jsii_get_property("useCustomCookbooks")
end

#use_custom_cookbooks=(value) ⇒ Object



516
517
518
519
# File 'ops_works/cfn_stack.rb', line 516

def use_custom_cookbooks=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useCustomCookbooks") unless value.nil?
  jsii_set_property("useCustomCookbooks", value)
end

#use_opsworks_security_groupsBoolean, ...

Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.

Returns:



524
525
526
# File 'ops_works/cfn_stack.rb', line 524

def use_opsworks_security_groups()
  jsii_get_property("useOpsworksSecurityGroups")
end

#use_opsworks_security_groups=(value) ⇒ Object



528
529
530
531
# File 'ops_works/cfn_stack.rb', line 528

def use_opsworks_security_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "useOpsworksSecurityGroups") unless value.nil?
  jsii_set_property("useOpsworksSecurityGroups", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


822
823
824
825
# File 'ops_works/cfn_stack.rb', line 822

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_idString?

The ID of the VPC that the stack is to be launched into.

Returns:

  • (String, nil)


536
537
538
# File 'ops_works/cfn_stack.rb', line 536

def vpc_id()
  jsii_get_property("vpcId")
end

#vpc_id=(value) ⇒ Object



540
541
542
543
# File 'ops_works/cfn_stack.rb', line 540

def vpc_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vpcId") unless value.nil?
  jsii_set_property("vpcId", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct)


561
562
563
564
565
566
# File 'ops_works/cfn_stack.rb', line 561

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end