Class: AWSCDK::MemoryDB::CfnCluster
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::MemoryDB::CfnCluster
- Includes:
- IInspectable, ITaggable, Interfaces::AWSMemorydb::IClusterRef
- Defined in:
- memory_db/cfn_cluster.rb
Overview
Specifies a cluster .
All nodes in the cluster run the same protocol-compliant engine software.
Class Method Summary collapse
- .arn_for_cluster(resource) ⇒ String
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.from_cluster_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSMemorydb::IClusterRef
Creates a new IClusterRef from an ARN.
-
.from_cluster_name(scope, id, cluster_name) ⇒ AWSCDK::Interfaces::AWSMemorydb::IClusterRef
Creates a new IClusterRef from a clusterName.
-
.is_cfn_cluster(x) ⇒ Boolean
Checks whether the given object is a CfnCluster.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#acl_name ⇒ String
The name of the Access Control List to associate with the cluster .
- #acl_name=(value) ⇒ Object
-
#add_deletion_override(path) ⇒ void
Syntactic sugar for
addOverride(path, undefined). -
#add_dependency(target) ⇒ void
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
-
#add_depends_on(target) ⇒ void
deprecated
Deprecated.
use addDependency
-
#add_metadata(key, value) ⇒ void
Add a value to the CloudFormation Resource Metadata.
-
#add_override(path, value) ⇒ void
Adds an override to the synthesized CloudFormation resource.
-
#add_property_deletion_override(property_path) ⇒ void
Adds an override that deletes the value of a property from the resource definition.
-
#add_property_override(property_path, value) ⇒ void
Adds an override to a resource property.
-
#apply_cross_stack_reference_strength(strength) ⇒ void
Sets the cross-stack reference strength for this resource.
-
#apply_removal_policy(policy = nil, options = nil) ⇒ void
Sets the deletion policy of the resource based on the removal policy specified.
-
#attr_arn ⇒ String
When you pass the logical ID of this resource to the intrinsic
Reffunction, Ref returns the ARN of the cluster , such asarn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster. -
#attr_cluster_endpoint_address ⇒ String
The address of the cluster 's configuration endpoint.
-
#attr_cluster_endpoint_port ⇒ Numeric
The port used by the cluster configuration endpoint.
-
#attr_parameter_group_status ⇒ String
The status of the parameter group used by the cluster , for example
activeorapplying. -
#attr_status ⇒ String
The status of the cluster.
-
#auto_minor_version_upgrade ⇒ Boolean, ...
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
- #auto_minor_version_upgrade=(value) ⇒ Object
-
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
- #cfn_properties ⇒ Hash{String => Object}
- #cfn_property_name(cdk_property_name) ⇒ String?
- #cfn_property_names ⇒ Hash{String => String}
-
#cfn_resource_type ⇒ String
AWS resource type.
-
#cluster_endpoint ⇒ AWSCDK::IResolvable, ...
The cluster 's configuration endpoint.
- #cluster_endpoint=(value) ⇒ Object
-
#cluster_name ⇒ String
The name of the cluster .
- #cluster_name=(value) ⇒ Object
-
#cluster_ref ⇒ AWSCDK::Interfaces::AWSMemorydb::ClusterReference
A reference to a Cluster resource.
- #creation_stack ⇒ Array<String>
-
#data_tiering ⇒ String?
Enables data tiering.
- #data_tiering=(value) ⇒ Object
-
#description ⇒ String?
A description of the cluster .
- #description=(value) ⇒ Object
-
#engine ⇒ String?
The name of the engine used by the cluster.
- #engine=(value) ⇒ Object
-
#engine_version ⇒ String?
The Redis engine version used by the cluster .
- #engine_version=(value) ⇒ Object
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#final_snapshot_name ⇒ String?
The user-supplied name of a final cluster snapshot.
- #final_snapshot_name=(value) ⇒ Object
-
#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference
Returns a token for an runtime attribute of this resource.
-
#get_metadata(key) ⇒ Object
Retrieve a value value from the CloudFormation Resource Metadata.
-
#initialize(scope, id, props) ⇒ CfnCluster
constructor
Create a new
AWS::MemoryDB::Cluster. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#ip_discovery ⇒ String?
The mechanism that the cluster uses to discover IP addresses.
- #ip_discovery=(value) ⇒ Object
-
#kms_key_id ⇒ String?
The ID of the KMS key used to encrypt the cluster .
- #kms_key_id=(value) ⇒ Object
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#maintenance_window ⇒ String?
Specifies the weekly time range during which maintenance on the cluster is performed.
- #maintenance_window=(value) ⇒ Object
-
#multi_region_cluster_name ⇒ String?
The name of the multi-Region cluster that this cluster belongs to.
- #multi_region_cluster_name=(value) ⇒ Object
-
#network_type ⇒ String?
The IP address type for the cluster.
- #network_type=(value) ⇒ Object
-
#node ⇒ Constructs::Node
The tree node.
-
#node_type ⇒ String
The cluster 's node type.
- #node_type=(value) ⇒ Object
-
#num_replicas_per_shard ⇒ Numeric?
The number of replicas to apply to each shard.
- #num_replicas_per_shard=(value) ⇒ Object
-
#num_shards ⇒ Numeric?
The number of shards in the cluster .
- #num_shards=(value) ⇒ Object
-
#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>
Retrieves an array of resources this resource depends on.
-
#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>
Get a shallow copy of dependencies between this resource and other resources in the same stack.
-
#override_logical_id(new_logical_id) ⇒ void
Overrides the auto-generated logical ID with a specific ID.
-
#parameter_group_name ⇒ String?
The name of the parameter group used by the cluster .
- #parameter_group_name=(value) ⇒ Object
-
#port ⇒ Numeric?
The port used by the cluster .
- #port=(value) ⇒ Object
-
#ref ⇒ String
Return a string that will be resolved to a CloudFormation
{ Ref }for this element. -
#remove_dependency(target) ⇒ void
Indicates that this resource no longer depends on another resource.
- #render_properties(props) ⇒ Hash{String => Object}
-
#replace_dependency(target, new_target) ⇒ void
Replaces one dependency with another.
-
#security_group_ids ⇒ Array<String>?
A list of security group names to associate with this cluster .
- #security_group_ids=(value) ⇒ Object
-
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
-
#snapshot_arns ⇒ Array<String>?
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
- #snapshot_arns=(value) ⇒ Object
-
#snapshot_name ⇒ String?
The name of a snapshot from which to restore data into the new cluster .
- #snapshot_name=(value) ⇒ Object
-
#snapshot_retention_limit ⇒ Numeric?
The number of days for which MemoryDB retains automatic snapshots before deleting them.
- #snapshot_retention_limit=(value) ⇒ Object
-
#snapshot_window ⇒ String?
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
- #snapshot_window=(value) ⇒ Object
-
#sns_topic_arn ⇒ String?
When you pass the logical ID of this resource to the intrinsic
Reffunction, Ref returns the ARN of the SNS topic, such asarn:aws:memorydb:us-east-1:123456789012:mySNSTopic. - #sns_topic_arn=(value) ⇒ Object
-
#sns_topic_status ⇒ String?
The SNS topic must be in Active status to receive notifications.
- #sns_topic_status=(value) ⇒ Object
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#subnet_group_name ⇒ String?
The name of the subnet group used by the cluster .
- #subnet_group_name=(value) ⇒ Object
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
An array of key-value pairs to apply to this resource.
- #tags_raw=(value) ⇒ Object
-
#tls_enabled ⇒ Boolean, ...
A flag to indicate if In-transit encryption is enabled.
- #tls_enabled=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#updated_properites ⇒ Hash{String => Object}
deprecated
Deprecated.
use
updatedPropertiesReturn properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource. -
#updated_properties ⇒ Hash{String => Object}
Return properties modified after initiation.
- #validate_properties(_properties) ⇒ void
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnCluster
Create a new AWS::MemoryDB::Cluster.
20 21 22 23 24 25 26 |
# File 'memory_db/cfn_cluster.rb', line 20 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::MemoryDB::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVtb3J5ZGIuQ2ZuQ2x1c3RlclByb3BzIn0=")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.arn_for_cluster(resource) ⇒ String
106 107 108 109 |
# File 'memory_db/cfn_cluster.rb', line 106 def self.arn_for_cluster(resource) Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZW1vcnlkYi5JQ2x1c3RlclJlZiJ9")), "resource") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_memorydb.CfnCluster", "arnForCluster", [resource]) end |
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
239 240 241 |
# File 'memory_db/cfn_cluster.rb', line 239 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_memorydb.CfnCluster", "CFN_RESOURCE_TYPE_NAME") end |
.from_cluster_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSMemorydb::IClusterRef
Creates a new IClusterRef from an ARN.
117 118 119 120 121 122 |
# File 'memory_db/cfn_cluster.rb', line 117 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_memorydb.CfnCluster", "fromClusterArn", [scope, id, arn]) end |
.from_cluster_name(scope, id, cluster_name) ⇒ AWSCDK::Interfaces::AWSMemorydb::IClusterRef
Creates a new IClusterRef from a clusterName.
130 131 132 133 134 135 |
# File 'memory_db/cfn_cluster.rb', line 130 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_memorydb.CfnCluster", "fromClusterName", [scope, id, cluster_name]) end |
.is_cfn_cluster(x) ⇒ Boolean
Checks whether the given object is a CfnCluster.
141 142 143 144 |
# File 'memory_db/cfn_cluster.rb', line 141 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_memorydb.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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'memory_db/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_endpoint_address => { kind: :property, name: "attrClusterEndpointAddress", is_optional: false }, :attr_cluster_endpoint_port => { kind: :property, name: "attrClusterEndpointPort", is_optional: false }, :attr_parameter_group_status => { kind: :property, name: "attrParameterGroupStatus", is_optional: false }, :attr_status => { kind: :property, name: "attrStatus", is_optional: false }, :cluster_ref => { kind: :property, name: "clusterRef", is_optional: false }, :tags => { kind: :property, name: "tags", is_optional: false }, :acl_name => { kind: :property, name: "aclName", is_optional: false }, :cluster_name => { kind: :property, name: "clusterName", is_optional: false }, :node_type => { kind: :property, name: "nodeType", is_optional: false }, :auto_minor_version_upgrade => { kind: :property, name: "autoMinorVersionUpgrade", is_optional: true }, :cluster_endpoint => { kind: :property, name: "clusterEndpoint", is_optional: true }, :data_tiering => { kind: :property, name: "dataTiering", is_optional: true }, :description => { kind: :property, name: "description", is_optional: true }, :engine => { kind: :property, name: "engine", is_optional: true }, :engine_version => { kind: :property, name: "engineVersion", is_optional: true }, :final_snapshot_name => { kind: :property, name: "finalSnapshotName", is_optional: true }, :ip_discovery => { kind: :property, name: "ipDiscovery", is_optional: true }, :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true }, :maintenance_window => { kind: :property, name: "maintenanceWindow", is_optional: true }, :multi_region_cluster_name => { kind: :property, name: "multiRegionClusterName", is_optional: true }, :network_type => { kind: :property, name: "networkType", is_optional: true }, :num_replicas_per_shard => { kind: :property, name: "numReplicasPerShard", is_optional: true }, :num_shards => { kind: :property, name: "numShards", is_optional: true }, :parameter_group_name => { kind: :property, name: "parameterGroupName", is_optional: true }, :port => { kind: :property, name: "port", is_optional: true }, :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true }, :snapshot_arns => { kind: :property, name: "snapshotArns", is_optional: true }, :snapshot_name => { kind: :property, name: "snapshotName", is_optional: true }, :snapshot_retention_limit => { kind: :property, name: "snapshotRetentionLimit", is_optional: true }, :snapshot_window => { kind: :property, name: "snapshotWindow", is_optional: true }, :sns_topic_arn => { kind: :property, name: "snsTopicArn", is_optional: true }, :sns_topic_status => { kind: :property, name: "snsTopicStatus", is_optional: true }, :subnet_group_name => { kind: :property, name: "subnetGroupName", is_optional: true }, :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true }, :tls_enabled => { kind: :property, name: "tlsEnabled", 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
#acl_name ⇒ String
The name of the Access Control List to associate with the cluster .
297 298 299 |
# File 'memory_db/cfn_cluster.rb', line 297 def acl_name() jsii_get_property("aclName") end |
#acl_name=(value) ⇒ Object
301 302 303 304 |
# File 'memory_db/cfn_cluster.rb', line 301 def acl_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "aclName") jsii_set_property("aclName", value) end |
#add_deletion_override(path) ⇒ void
This method returns an undefined value.
Syntactic sugar for addOverride(path, undefined).
680 681 682 683 |
# File 'memory_db/cfn_cluster.rb', line 680 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.
692 693 694 695 |
# File 'memory_db/cfn_cluster.rb', line 692 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
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.
702 703 704 705 |
# File 'memory_db/cfn_cluster.rb', line 702 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.
713 714 715 716 717 |
# File 'memory_db/cfn_cluster.rb', line 713 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.
770 771 772 773 774 |
# File 'memory_db/cfn_cluster.rb', line 770 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.
780 781 782 783 |
# File 'memory_db/cfn_cluster.rb', line 780 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).
792 793 794 795 796 |
# File 'memory_db/cfn_cluster.rb', line 792 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.
805 806 807 808 |
# File 'memory_db/cfn_cluster.rb', line 805 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:
827 828 829 830 831 832 |
# File 'memory_db/cfn_cluster.rb', line 827 def apply_removal_policy(policy = nil, = nil) Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil? = .is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**.transform_keys(&:to_sym)) : Jsii::Type.check_type(, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless .nil? jsii_call_method("applyRemovalPolicy", [policy, ]) end |
#attr_arn ⇒ String
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the cluster , such as arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster.
246 247 248 |
# File 'memory_db/cfn_cluster.rb', line 246 def attr_arn() jsii_get_property("attrArn") end |
#attr_cluster_endpoint_address ⇒ String
The address of the cluster 's configuration endpoint.
253 254 255 |
# File 'memory_db/cfn_cluster.rb', line 253 def attr_cluster_endpoint_address() jsii_get_property("attrClusterEndpointAddress") end |
#attr_cluster_endpoint_port ⇒ Numeric
The port used by the cluster configuration endpoint.
260 261 262 |
# File 'memory_db/cfn_cluster.rb', line 260 def attr_cluster_endpoint_port() jsii_get_property("attrClusterEndpointPort") end |
#attr_parameter_group_status ⇒ String
The status of the parameter group used by the cluster , for example active or applying .
267 268 269 |
# File 'memory_db/cfn_cluster.rb', line 267 def attr_parameter_group_status() jsii_get_property("attrParameterGroupStatus") end |
#attr_status ⇒ String
The status of the cluster.
For example, 'available', 'updating' or 'creating'.
276 277 278 |
# File 'memory_db/cfn_cluster.rb', line 276 def attr_status() jsii_get_property("attrStatus") end |
#auto_minor_version_upgrade ⇒ Boolean, ...
When set to true, the cluster will automatically receive minor engine version upgrades after launch.
333 334 335 |
# File 'memory_db/cfn_cluster.rb', line 333 def auto_minor_version_upgrade() jsii_get_property("autoMinorVersionUpgrade") end |
#auto_minor_version_upgrade=(value) ⇒ Object
337 338 339 340 |
# File 'memory_db/cfn_cluster.rb', line 337 def auto_minor_version_upgrade=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "autoMinorVersionUpgrade") unless value.nil? jsii_set_property("autoMinorVersionUpgrade", value) end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
192 193 194 |
# File 'memory_db/cfn_cluster.rb', line 192 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
197 198 199 |
# File 'memory_db/cfn_cluster.rb', line 197 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
836 837 838 839 |
# File 'memory_db/cfn_cluster.rb', line 836 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}
202 203 204 |
# File 'memory_db/cfn_cluster.rb', line 202 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
209 210 211 |
# File 'memory_db/cfn_cluster.rb', line 209 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#cluster_endpoint ⇒ AWSCDK::IResolvable, ...
The cluster 's configuration endpoint.
345 346 347 |
# File 'memory_db/cfn_cluster.rb', line 345 def cluster_endpoint() jsii_get_property("clusterEndpoint") end |
#cluster_endpoint=(value) ⇒ Object
349 350 351 352 353 |
# File 'memory_db/cfn_cluster.rb', line 349 def cluster_endpoint=(value) value = value.is_a?(Hash) ? ::AWSCDK::MemoryDB::CfnCluster::EndpointProperty.new(**value.transform_keys(&:to_sym)) : value Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZW1vcnlkYi5DZm5DbHVzdGVyLkVuZHBvaW50UHJvcGVydHkifV19fQ==")), "clusterEndpoint") unless value.nil? jsii_set_property("clusterEndpoint", value) end |
#cluster_name ⇒ String
The name of the cluster .
309 310 311 |
# File 'memory_db/cfn_cluster.rb', line 309 def cluster_name() jsii_get_property("clusterName") end |
#cluster_name=(value) ⇒ Object
313 314 315 316 |
# File 'memory_db/cfn_cluster.rb', line 313 def cluster_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterName") jsii_set_property("clusterName", value) end |
#cluster_ref ⇒ AWSCDK::Interfaces::AWSMemorydb::ClusterReference
A reference to a Cluster resource.
283 284 285 |
# File 'memory_db/cfn_cluster.rb', line 283 def cluster_ref() jsii_get_property("clusterRef") end |
#creation_stack ⇒ Array<String>
154 155 156 |
# File 'memory_db/cfn_cluster.rb', line 154 def creation_stack() jsii_get_property("creationStack") end |
#data_tiering ⇒ String?
Enables data tiering.
358 359 360 |
# File 'memory_db/cfn_cluster.rb', line 358 def data_tiering() jsii_get_property("dataTiering") end |
#data_tiering=(value) ⇒ Object
362 363 364 365 |
# File 'memory_db/cfn_cluster.rb', line 362 def data_tiering=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataTiering") unless value.nil? jsii_set_property("dataTiering", value) end |
#description ⇒ String?
A description of the cluster .
370 371 372 |
# File 'memory_db/cfn_cluster.rb', line 370 def description() jsii_get_property("description") end |
#description=(value) ⇒ Object
374 375 376 377 |
# File 'memory_db/cfn_cluster.rb', line 374 def description=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil? jsii_set_property("description", value) end |
#engine ⇒ String?
The name of the engine used by the cluster.
382 383 384 |
# File 'memory_db/cfn_cluster.rb', line 382 def engine() jsii_get_property("engine") end |
#engine=(value) ⇒ Object
386 387 388 389 |
# File 'memory_db/cfn_cluster.rb', line 386 def engine=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine") unless value.nil? jsii_set_property("engine", value) end |
#engine_version ⇒ String?
The Redis engine version used by the cluster .
394 395 396 |
# File 'memory_db/cfn_cluster.rb', line 394 def engine_version() jsii_get_property("engineVersion") end |
#engine_version=(value) ⇒ Object
398 399 400 401 |
# File 'memory_db/cfn_cluster.rb', line 398 def engine_version=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engineVersion") unless value.nil? jsii_set_property("engineVersion", value) end |
#env ⇒ AWSCDK::Interfaces::ResourceEnvironment
214 215 216 |
# File 'memory_db/cfn_cluster.rb', line 214 def env() jsii_get_property("env") end |
#final_snapshot_name ⇒ String?
The user-supplied name of a final cluster snapshot.
406 407 408 |
# File 'memory_db/cfn_cluster.rb', line 406 def final_snapshot_name() jsii_get_property("finalSnapshotName") end |
#final_snapshot_name=(value) ⇒ Object
410 411 412 413 |
# File 'memory_db/cfn_cluster.rb', line 410 def final_snapshot_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "finalSnapshotName") unless value.nil? jsii_set_property("finalSnapshotName", value) 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.
849 850 851 852 853 |
# File 'memory_db/cfn_cluster.rb', line 849 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.
860 861 862 863 |
# File 'memory_db/cfn_cluster.rb', line 860 def (key) Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") jsii_call_method("getMetadata", [key]) end |
#inspect(inspector) ⇒ void
This method returns an undefined value.
Examines the CloudFormation resource and discloses attributes.
930 931 932 933 |
# File 'memory_db/cfn_cluster.rb', line 930 def inspect(inspector) Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector") jsii_call_method("inspect", [inspector]) end |
#ip_discovery ⇒ String?
The mechanism that the cluster uses to discover IP addresses.
418 419 420 |
# File 'memory_db/cfn_cluster.rb', line 418 def ip_discovery() jsii_get_property("ipDiscovery") end |
#ip_discovery=(value) ⇒ Object
422 423 424 425 |
# File 'memory_db/cfn_cluster.rb', line 422 def ip_discovery=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipDiscovery") unless value.nil? jsii_set_property("ipDiscovery", value) end |
#kms_key_id ⇒ String?
The ID of the KMS key used to encrypt the cluster .
430 431 432 |
# File 'memory_db/cfn_cluster.rb', line 430 def kms_key_id() jsii_get_property("kmsKeyId") end |
#kms_key_id=(value) ⇒ Object
434 435 436 437 |
# File 'memory_db/cfn_cluster.rb', line 434 def kms_key_id=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyId") unless value.nil? jsii_set_property("kmsKeyId", value) 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).
166 167 168 |
# File 'memory_db/cfn_cluster.rb', line 166 def logical_id() jsii_get_property("logicalId") end |
#maintenance_window ⇒ String?
Specifies the weekly time range during which maintenance on the cluster is performed.
442 443 444 |
# File 'memory_db/cfn_cluster.rb', line 442 def maintenance_window() jsii_get_property("maintenanceWindow") end |
#maintenance_window=(value) ⇒ Object
446 447 448 449 |
# File 'memory_db/cfn_cluster.rb', line 446 def maintenance_window=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "maintenanceWindow") unless value.nil? jsii_set_property("maintenanceWindow", value) end |
#multi_region_cluster_name ⇒ String?
The name of the multi-Region cluster that this cluster belongs to.
454 455 456 |
# File 'memory_db/cfn_cluster.rb', line 454 def multi_region_cluster_name() jsii_get_property("multiRegionClusterName") end |
#multi_region_cluster_name=(value) ⇒ Object
458 459 460 461 |
# File 'memory_db/cfn_cluster.rb', line 458 def multi_region_cluster_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "multiRegionClusterName") unless value.nil? jsii_set_property("multiRegionClusterName", value) end |
#network_type ⇒ String?
The IP address type for the cluster.
466 467 468 |
# File 'memory_db/cfn_cluster.rb', line 466 def network_type() jsii_get_property("networkType") end |
#network_type=(value) ⇒ Object
470 471 472 473 |
# File 'memory_db/cfn_cluster.rb', line 470 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.
149 150 151 |
# File 'memory_db/cfn_cluster.rb', line 149 def node() jsii_get_property("node") end |
#node_type ⇒ String
The cluster 's node type.
321 322 323 |
# File 'memory_db/cfn_cluster.rb', line 321 def node_type() jsii_get_property("nodeType") end |
#node_type=(value) ⇒ Object
325 326 327 328 |
# File 'memory_db/cfn_cluster.rb', line 325 def node_type=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nodeType") jsii_set_property("nodeType", value) end |
#num_replicas_per_shard ⇒ Numeric?
The number of replicas to apply to each shard.
478 479 480 |
# File 'memory_db/cfn_cluster.rb', line 478 def num_replicas_per_shard() jsii_get_property("numReplicasPerShard") end |
#num_replicas_per_shard=(value) ⇒ Object
482 483 484 485 |
# File 'memory_db/cfn_cluster.rb', line 482 def num_replicas_per_shard=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numReplicasPerShard") unless value.nil? jsii_set_property("numReplicasPerShard", value) end |
#num_shards ⇒ Numeric?
The number of shards in the cluster .
490 491 492 |
# File 'memory_db/cfn_cluster.rb', line 490 def num_shards() jsii_get_property("numShards") end |
#num_shards=(value) ⇒ Object
494 495 496 497 |
# File 'memory_db/cfn_cluster.rb', line 494 def num_shards=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numShards") unless value.nil? jsii_set_property("numShards", 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.
871 872 873 |
# File 'memory_db/cfn_cluster.rb', line 871 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.
878 879 880 |
# File 'memory_db/cfn_cluster.rb', line 878 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.
671 672 673 674 |
# File 'memory_db/cfn_cluster.rb', line 671 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 name of the parameter group used by the cluster .
502 503 504 |
# File 'memory_db/cfn_cluster.rb', line 502 def parameter_group_name() jsii_get_property("parameterGroupName") end |
#parameter_group_name=(value) ⇒ Object
506 507 508 509 |
# File 'memory_db/cfn_cluster.rb', line 506 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 |
#port ⇒ Numeric?
The port used by the cluster .
514 515 516 |
# File 'memory_db/cfn_cluster.rb', line 514 def port() jsii_get_property("port") end |
#port=(value) ⇒ Object
518 519 520 521 |
# File 'memory_db/cfn_cluster.rb', line 518 def port=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless value.nil? jsii_set_property("port", 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 }).
185 186 187 |
# File 'memory_db/cfn_cluster.rb', line 185 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.
889 890 891 892 |
# File 'memory_db/cfn_cluster.rb', line 889 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}
896 897 898 899 |
# File 'memory_db/cfn_cluster.rb', line 896 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.
906 907 908 909 910 |
# File 'memory_db/cfn_cluster.rb', line 906 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 |
#security_group_ids ⇒ Array<String>?
A list of security group names to associate with this cluster .
526 527 528 |
# File 'memory_db/cfn_cluster.rb', line 526 def security_group_ids() jsii_get_property("securityGroupIds") end |
#security_group_ids=(value) ⇒ Object
530 531 532 533 |
# File 'memory_db/cfn_cluster.rb', line 530 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.
915 916 917 |
# File 'memory_db/cfn_cluster.rb', line 915 def should_synthesize() jsii_call_method("shouldSynthesize", []) end |
#snapshot_arns ⇒ Array<String>?
A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
538 539 540 |
# File 'memory_db/cfn_cluster.rb', line 538 def snapshot_arns() jsii_get_property("snapshotArns") end |
#snapshot_arns=(value) ⇒ Object
542 543 544 545 |
# File 'memory_db/cfn_cluster.rb', line 542 def snapshot_arns=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "snapshotArns") unless value.nil? jsii_set_property("snapshotArns", value) end |
#snapshot_name ⇒ String?
The name of a snapshot from which to restore data into the new cluster .
550 551 552 |
# File 'memory_db/cfn_cluster.rb', line 550 def snapshot_name() jsii_get_property("snapshotName") end |
#snapshot_name=(value) ⇒ Object
554 555 556 557 |
# File 'memory_db/cfn_cluster.rb', line 554 def snapshot_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotName") unless value.nil? jsii_set_property("snapshotName", value) end |
#snapshot_retention_limit ⇒ Numeric?
The number of days for which MemoryDB retains automatic snapshots before deleting them.
562 563 564 |
# File 'memory_db/cfn_cluster.rb', line 562 def snapshot_retention_limit() jsii_get_property("snapshotRetentionLimit") end |
#snapshot_retention_limit=(value) ⇒ Object
566 567 568 569 |
# File 'memory_db/cfn_cluster.rb', line 566 def snapshot_retention_limit=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "snapshotRetentionLimit") unless value.nil? jsii_set_property("snapshotRetentionLimit", value) end |
#snapshot_window ⇒ String?
The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
574 575 576 |
# File 'memory_db/cfn_cluster.rb', line 574 def snapshot_window() jsii_get_property("snapshotWindow") end |
#snapshot_window=(value) ⇒ Object
578 579 580 581 |
# File 'memory_db/cfn_cluster.rb', line 578 def snapshot_window=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snapshotWindow") unless value.nil? jsii_set_property("snapshotWindow", value) end |
#sns_topic_arn ⇒ String?
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the SNS topic, such as arn:aws:memorydb:us-east-1:123456789012:mySNSTopic.
586 587 588 |
# File 'memory_db/cfn_cluster.rb', line 586 def sns_topic_arn() jsii_get_property("snsTopicArn") end |
#sns_topic_arn=(value) ⇒ Object
590 591 592 593 |
# File 'memory_db/cfn_cluster.rb', line 590 def sns_topic_arn=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snsTopicArn") unless value.nil? jsii_set_property("snsTopicArn", value) end |
#sns_topic_status ⇒ String?
The SNS topic must be in Active status to receive notifications.
598 599 600 |
# File 'memory_db/cfn_cluster.rb', line 598 def sns_topic_status() jsii_get_property("snsTopicStatus") end |
#sns_topic_status=(value) ⇒ Object
602 603 604 605 |
# File 'memory_db/cfn_cluster.rb', line 602 def sns_topic_status=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "snsTopicStatus") unless value.nil? jsii_set_property("snsTopicStatus", value) end |
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
175 176 177 |
# File 'memory_db/cfn_cluster.rb', line 175 def stack() jsii_get_property("stack") end |
#subnet_group_name ⇒ String?
The name of the subnet group used by the cluster .
610 611 612 |
# File 'memory_db/cfn_cluster.rb', line 610 def subnet_group_name() jsii_get_property("subnetGroupName") end |
#subnet_group_name=(value) ⇒ Object
614 615 616 617 |
# File 'memory_db/cfn_cluster.rb', line 614 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.
290 291 292 |
# File 'memory_db/cfn_cluster.rb', line 290 def () jsii_get_property("tags") end |
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
An array of key-value pairs to apply to this resource.
622 623 624 |
# File 'memory_db/cfn_cluster.rb', line 622 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
626 627 628 629 630 |
# File 'memory_db/cfn_cluster.rb', line 626 def (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 |
#tls_enabled ⇒ Boolean, ...
A flag to indicate if In-transit encryption is enabled.
635 636 637 |
# File 'memory_db/cfn_cluster.rb', line 635 def tls_enabled() jsii_get_property("tlsEnabled") end |
#tls_enabled=(value) ⇒ Object
639 640 641 642 |
# File 'memory_db/cfn_cluster.rb', line 639 def tls_enabled=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "tlsEnabled") unless value.nil? jsii_set_property("tlsEnabled", value) end |
#to_string ⇒ String
Returns a string representation of this construct.
647 648 649 |
# File 'memory_db/cfn_cluster.rb', line 647 def to_string() jsii_call_method("toString", []) end |
#updated_properites ⇒ Hash{String => Object}
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.
222 223 224 |
# File 'memory_db/cfn_cluster.rb', line 222 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.
232 233 234 |
# File 'memory_db/cfn_cluster.rb', line 232 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
921 922 923 924 |
# File 'memory_db/cfn_cluster.rb', line 921 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.
660 661 662 663 664 665 |
# File 'memory_db/cfn_cluster.rb', line 660 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 |