Class: AWSCDK::DAX::CfnCluster

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSDAX::IClusterRef
Defined in:
dax/cfn_cluster.rb

Overview

Creates a DAX cluster.

All nodes in the cluster run the same DAX caching software.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCluster

Create a new AWS::DAX::Cluster.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::DAX::CfnClusterProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'dax/cfn_cluster.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::DAX::CfnClusterProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGF4LkNmbkNsdXN0ZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_cluster(resource) ⇒ String

Parameters:

Returns:

  • (String) 


91
92
93
94
 
# File 'dax/cfn_cluster.rb', line 91

def self.arn_for_cluster(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kYXguSUNsdXN0ZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dax.CfnCluster", "arnForCluster", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


224
225
226
 
# File 'dax/cfn_cluster.rb', line 224

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

.from_cluster_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSDAX::IClusterRef

Creates a new IClusterRef from an ARN.

Parameters:

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

Returns:



102
103
104
105
106
107
 
# File 'dax/cfn_cluster.rb', line 102

def self.from_cluster_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dax.CfnCluster", "fromClusterArn", [scope, id, arn])
end

.from_cluster_name(scope, id, cluster_name) ⇒ AWSCDK::Interfaces::AWSDAX::IClusterRef

Creates a new IClusterRef from a clusterName.

Parameters:

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

Returns:



115
116
117
118
119
120
 
# File 'dax/cfn_cluster.rb', line 115

def self.from_cluster_name(scope, id, cluster_name)
  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(cluster_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dax.CfnCluster", "fromClusterName", [scope, id, cluster_name])
end

.is_cfn_cluster(x) ⇒ Boolean

Checks whether the given object is a CfnCluster.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


126
127
128
129
 
# File 'dax/cfn_cluster.rb', line 126

def self.is_cfn_cluster(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_dax.CfnCluster", "isCfnCluster", [x])
end

.jsii_overridable_methods ⇒ Object 



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
 
# File 'dax/cfn_cluster.rb', line 28

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_cluster_discovery_endpoint => { kind: :property, name: "attrClusterDiscoveryEndpoint", is_optional: false },
    :attr_cluster_discovery_endpoint_url => { kind: :property, name: "attrClusterDiscoveryEndpointUrl", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :cluster_ref => { kind: :property, name: "clusterRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :iam_role_arn => { kind: :property, name: "iamRoleArn", is_optional: false },
    :node_type => { kind: :property, name: "nodeType", is_optional: false },
    :replication_factor => { kind: :property, name: "replicationFactor", is_optional: false },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false },
    :availability_zones => { kind: :property, name: "availabilityZones", is_optional: true },
    :cluster_endpoint_encryption_type => { kind: :property, name: "clusterEndpointEncryptionType", is_optional: true },
    :cluster_name => { kind: :property, name: "clusterName", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :notification_topic_arn => { kind: :property, name: "notificationTopicArn", is_optional: true },
    :parameter_group_name => { kind: :property, name: "parameterGroupName", is_optional: true },
    :preferred_maintenance_window => { kind: :property, name: "preferredMaintenanceWindow", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :sse_specification => { kind: :property, name: "sseSpecification", is_optional: true },
    :subnet_group_name => { kind: :property, name: "subnetGroupName", 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.



501
502
503
504
 
# File 'dax/cfn_cluster.rb', line 501

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:



513
514
515
516
 
# File 'dax/cfn_cluster.rb', line 513

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:



523
524
525
526
 
# File 'dax/cfn_cluster.rb', line 523

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.

Parameters:

  • key (String)
  • value (Object)

See Also:



534
535
536
537
538
 
# File 'dax/cfn_cluster.rb', line 534

def add_metadata(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.


591
592
593
594
595
 
# File 'dax/cfn_cluster.rb', line 591

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.



601
602
603
604
 
# File 'dax/cfn_cluster.rb', line 601

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.



613
614
615
616
617
 
# File 'dax/cfn_cluster.rb', line 613

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

#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:



626
627
628
629
 
# File 'dax/cfn_cluster.rb', line 626

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:

Parameters:

See Also:



648
649
650
651
652
653
 
# File 'dax/cfn_cluster.rb', line 648

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_arn ⇒ String

Returns the ARN of the DAX cluster. For example:.

{ "Fn::GetAtt": [" MyDAXCluster ", "Arn"] }

Returns a value similar to the following:

arn:aws:dax:us-east-1:111122223333:cache/MyDAXCluster

Returns:

  • (String) 


237
238
239
 
# File 'dax/cfn_cluster.rb', line 237

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_cluster_discovery_endpoint ⇒ String

Returns the endpoint of the DAX cluster. For example:.

{ "Fn::GetAtt": [" MyDAXCluster ", "ClusterDiscoveryEndpoint"] }

Returns a value similar to the following:

mydaxcluster.0h3d6x.clustercfg.dax.use1.cache.amazonaws.com:8111

Returns:

  • (String) 


250
251
252
 
# File 'dax/cfn_cluster.rb', line 250

def attr_cluster_discovery_endpoint()
  jsii_get_property("attrClusterDiscoveryEndpoint")
end

#attr_cluster_discovery_endpoint_url ⇒ String

Returns the endpoint URL of the DAX cluster.

Returns:

  • (String) 


257
258
259
 
# File 'dax/cfn_cluster.rb', line 257

def attr_cluster_discovery_endpoint_url()
  jsii_get_property("attrClusterDiscoveryEndpointUrl")
end

#attr_id ⇒ String

Returns:

  • (String) 


262
263
264
 
# File 'dax/cfn_cluster.rb', line 262

def attr_id()
  jsii_get_property("attrId")
end

#availability_zones ⇒ Array<String>?

The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.

Returns:

  • (Array<String>, nil) 


331
332
333
 
# File 'dax/cfn_cluster.rb', line 331

def availability_zones()
  jsii_get_property("availabilityZones")
end

#availability_zones=(value) ⇒ Object 



335
336
337
338
 
# File 'dax/cfn_cluster.rb', line 335

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



177
178
179
 
# File 'dax/cfn_cluster.rb', line 177

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


182
183
184
 
# File 'dax/cfn_cluster.rb', line 182

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


657
658
659
660
 
# File 'dax/cfn_cluster.rb', line 657

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_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


187
188
189
 
# File 'dax/cfn_cluster.rb', line 187

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


194
195
196
 
# File 'dax/cfn_cluster.rb', line 194

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_endpoint_encryption_type ⇒ String?

The encryption type of the cluster's endpoint.

Available values are:.

Returns:

  • (String, nil) 


345
346
347
 
# File 'dax/cfn_cluster.rb', line 345

def cluster_endpoint_encryption_type()
  jsii_get_property("clusterEndpointEncryptionType")
end

#cluster_endpoint_encryption_type=(value) ⇒ Object 



349
350
351
352
 
# File 'dax/cfn_cluster.rb', line 349

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

#cluster_name ⇒ String?

The name of the DAX cluster.

Returns:

  • (String, nil) 


357
358
359
 
# File 'dax/cfn_cluster.rb', line 357

def cluster_name()
  jsii_get_property("clusterName")
end

#cluster_name=(value) ⇒ Object 



361
362
363
364
 
# File 'dax/cfn_cluster.rb', line 361

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

#cluster_ref ⇒ AWSCDK::Interfaces::AWSDAX::ClusterReference

A reference to a Cluster resource.

Returns:



269
270
271
 
# File 'dax/cfn_cluster.rb', line 269

def cluster_ref()
  jsii_get_property("clusterRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


139
140
141
 
# File 'dax/cfn_cluster.rb', line 139

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the cluster.

Returns:

  • (String, nil) 


369
370
371
 
# File 'dax/cfn_cluster.rb', line 369

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



373
374
375
376
 
# File 'dax/cfn_cluster.rb', line 373

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



199
200
201
 
# File 'dax/cfn_cluster.rb', line 199

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:



670
671
672
673
674
 
# File 'dax/cfn_cluster.rb', line 670

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.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



681
682
683
684
 
# File 'dax/cfn_cluster.rb', line 681

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

#iam_role_arn ⇒ String

A valid Amazon Resource Name (ARN) that identifies an IAM role.

Returns:

  • (String) 


283
284
285
 
# File 'dax/cfn_cluster.rb', line 283

def iam_role_arn()
  jsii_get_property("iamRoleArn")
end

#iam_role_arn=(value) ⇒ Object 



287
288
289
290
 
# File 'dax/cfn_cluster.rb', line 287

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



751
752
753
754
 
# File 'dax/cfn_cluster.rb', line 751

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

#logical_id ⇒ String

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) 


151
152
153
 
# File 'dax/cfn_cluster.rb', line 151

def logical_id()
  jsii_get_property("logicalId")
end

#network_type ⇒ String?

The IP address type of the cluster.

Values are:.

Returns:

  • (String, nil) 


383
384
385
 
# File 'dax/cfn_cluster.rb', line 383

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



387
388
389
390
 
# File 'dax/cfn_cluster.rb', line 387

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


134
135
136
 
# File 'dax/cfn_cluster.rb', line 134

def node()
  jsii_get_property("node")
end

#node_type ⇒ String

The node type for the nodes in the cluster.

Returns:

  • (String) 


295
296
297
 
# File 'dax/cfn_cluster.rb', line 295

def node_type()
  jsii_get_property("nodeType")
end

#node_type=(value) ⇒ Object 



299
300
301
302
 
# File 'dax/cfn_cluster.rb', line 299

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

#notification_topic_arn ⇒ String?

The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

Returns:

  • (String, nil) 


395
396
397
 
# File 'dax/cfn_cluster.rb', line 395

def notification_topic_arn()
  jsii_get_property("notificationTopicArn")
end

#notification_topic_arn=(value) ⇒ Object 



399
400
401
402
 
# File 'dax/cfn_cluster.rb', line 399

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

#obtain_dependencies ⇒ Array<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:



692
693
694
 
# File 'dax/cfn_cluster.rb', line 692

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

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

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

Returns:



699
700
701
 
# File 'dax/cfn_cluster.rb', line 699

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.



492
493
494
495
 
# File 'dax/cfn_cluster.rb', line 492

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

#parameter_group_name ⇒ String?

The parameter group to be associated with the DAX cluster.

Returns:

  • (String, nil) 


407
408
409
 
# File 'dax/cfn_cluster.rb', line 407

def parameter_group_name()
  jsii_get_property("parameterGroupName")
end

#parameter_group_name=(value) ⇒ Object 



411
412
413
414
 
# File 'dax/cfn_cluster.rb', line 411

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

#preferred_maintenance_window ⇒ String?

A range of time when maintenance of DAX cluster software will be performed.

Returns:

  • (String, nil) 


419
420
421
 
# File 'dax/cfn_cluster.rb', line 419

def preferred_maintenance_window()
  jsii_get_property("preferredMaintenanceWindow")
end

#preferred_maintenance_window=(value) ⇒ Object 



423
424
425
426
 
# File 'dax/cfn_cluster.rb', line 423

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

#ref ⇒ String

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) 


170
171
172
 
# File 'dax/cfn_cluster.rb', line 170

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:



710
711
712
713
 
# File 'dax/cfn_cluster.rb', line 710

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}) 


717
718
719
720
 
# File 'dax/cfn_cluster.rb', line 717

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:



727
728
729
730
731
 
# File 'dax/cfn_cluster.rb', line 727

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

#replication_factor ⇒ Numeric

The number of nodes in the DAX cluster.

Returns:

  • (Numeric) 


307
308
309
 
# File 'dax/cfn_cluster.rb', line 307

def replication_factor()
  jsii_get_property("replicationFactor")
end

#replication_factor=(value) ⇒ Object 



311
312
313
314
 
# File 'dax/cfn_cluster.rb', line 311

def replication_factor=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "replicationFactor")
  jsii_set_property("replicationFactor", value)
end

#security_group_ids ⇒ Array<String>?

A list of security group IDs to be assigned to each node in the DAX cluster.

Returns:

  • (Array<String>, nil) 


431
432
433
 
# File 'dax/cfn_cluster.rb', line 431

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



435
436
437
438
 
# File 'dax/cfn_cluster.rb', line 435

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

#should_synthesize ⇒ Boolean

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.



736
737
738
 
# File 'dax/cfn_cluster.rb', line 736

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

#sse_specification ⇒ AWSCDK::IResolvable, ...

Represents the settings used to enable server-side encryption on the cluster.

Returns:



443
444
445
 
# File 'dax/cfn_cluster.rb', line 443

def sse_specification()
  jsii_get_property("sseSpecification")
end

#sse_specification=(value) ⇒ Object 



447
448
449
450
451
 
# File 'dax/cfn_cluster.rb', line 447

def sse_specification=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DAX::CfnCluster::SSESpecificationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXguQ2ZuQ2x1c3Rlci5TU0VTcGVjaWZpY2F0aW9uUHJvcGVydHkifV19fQ==")), "sseSpecification") unless value.nil?
  jsii_set_property("sseSpecification", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



160
161
162
 
# File 'dax/cfn_cluster.rb', line 160

def stack()
  jsii_get_property("stack")
end

#subnet_group_name ⇒ String?

The name of the subnet group to be used for the replication group.

Returns:

  • (String, nil) 


456
457
458
 
# File 'dax/cfn_cluster.rb', line 456

def subnet_group_name()
  jsii_get_property("subnetGroupName")
end

#subnet_group_name=(value) ⇒ Object 



460
461
462
463
 
# File 'dax/cfn_cluster.rb', line 460

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

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



276
277
278
 
# File 'dax/cfn_cluster.rb', line 276

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Object

A set of tags to associate with the DAX cluster.

Returns:

  • (Object) 


319
320
321
 
# File 'dax/cfn_cluster.rb', line 319

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



323
324
325
326
 
# File 'dax/cfn_cluster.rb', line 323

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



468
469
470
 
# File 'dax/cfn_cluster.rb', line 468

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

#updated_properites ⇒ Hash{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}) 


207
208
209
 
# File 'dax/cfn_cluster.rb', line 207

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{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}) 


217
218
219
 
# File 'dax/cfn_cluster.rb', line 217

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


742
743
744
745
 
# File 'dax/cfn_cluster.rb', line 742

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


481
482
483
484
485
486
 
# File 'dax/cfn_cluster.rb', line 481

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