Class: AWSCDK::Elasticache::CfnCacheCluster
- Inherits:
-
CfnResource
- Object
- CfnResource
- AWSCDK::Elasticache::CfnCacheCluster
- Includes:
- IInspectable, ITaggable, Interfaces::AWSElasticache::ICacheClusterRef
- Defined in:
- elasticache/cfn_cache_cluster.rb
Overview
The AWS::ElastiCache::CacheCluster type creates an Amazon ElastiCache cache cluster.
Class Method Summary collapse
-
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
-
.is_cfn_cache_cluster(x) ⇒ Boolean
Checks whether the given object is a CfnCacheCluster.
- .jsii_overridable_methods ⇒ Object
Instance Method Summary collapse
-
#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_configuration_endpoint ⇒ AWSCDK::IResolvable
-
#attr_configuration_endpoint_address ⇒ String
The DNS hostname of the cache node.
-
#attr_configuration_endpoint_port ⇒ String
The port number of the configuration endpoint for the Memcached cache cluster.
- #attr_redis_endpoint ⇒ AWSCDK::IResolvable
-
#attr_redis_endpoint_address ⇒ String
The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster.
-
#attr_redis_endpoint_port ⇒ String
The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster.
-
#auto_minor_version_upgrade ⇒ Boolean, ...
If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign.
- #auto_minor_version_upgrade=(value) ⇒ Object
-
#az_mode ⇒ String?
Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
- #az_mode=(value) ⇒ Object
-
#cache_cluster_ref ⇒ AWSCDK::Interfaces::AWSElasticache::CacheClusterReference
A reference to a CacheCluster resource.
-
#cache_node_type ⇒ String
The compute and memory capacity of the nodes in the node group (shard).
- #cache_node_type=(value) ⇒ Object
-
#cache_parameter_group_name ⇒ String?
The name of the parameter group to associate with this cluster.
- #cache_parameter_group_name=(value) ⇒ Object
-
#cache_security_group_names ⇒ Array<String>?
deprecated
Deprecated.
this property has been deprecated
- #cache_security_group_names=(value) ⇒ Object
-
#cache_subnet_group_name ⇒ String?
The name of the subnet group to be used for the cluster.
- #cache_subnet_group_name=(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_name ⇒ String?
A name for the cache cluster.
- #cluster_name=(value) ⇒ Object
- #creation_stack ⇒ Array<String>
-
#engine ⇒ String
The name of the cache engine to be used for this cluster.
- #engine=(value) ⇒ Object
-
#engine_version ⇒ String?
The version number of the cache engine to be used for this cluster.
- #engine_version=(value) ⇒ Object
- #env ⇒ AWSCDK::Interfaces::ResourceEnvironment
-
#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) ⇒ CfnCacheCluster
constructor
Create a new
AWS::ElastiCache::CacheCluster. -
#inspect(inspector) ⇒ void
Examines the CloudFormation resource and discloses attributes.
-
#ip_discovery ⇒ String?
The network type you choose when modifying a cluster, either
ipv4|ipv6. - #ip_discovery=(value) ⇒ Object
-
#log_delivery_configurations ⇒ AWSCDK::IResolvable, ...
Specifies the destination, format and type of the logs.
- #log_delivery_configurations=(value) ⇒ Object
-
#logical_id ⇒ String
The logical ID for this CloudFormation stack element.
-
#network_type ⇒ String?
Must be either
ipv4|ipv6|dual_stack. - #network_type=(value) ⇒ Object
-
#node ⇒ Constructs::Node
The tree node.
-
#notification_topic_arn ⇒ String?
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
- #notification_topic_arn=(value) ⇒ Object
-
#num_cache_nodes ⇒ Numeric
The number of cache nodes that the cache cluster should have.
- #num_cache_nodes=(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.
-
#port ⇒ Numeric?
The port number on which each of the cache nodes accepts connections.
- #port=(value) ⇒ Object
-
#preferred_availability_zone ⇒ String?
The EC2 Availability Zone in which the cluster is created.
- #preferred_availability_zone=(value) ⇒ Object
-
#preferred_availability_zones ⇒ Array<String>?
A list of the Availability Zones in which cache nodes are created.
- #preferred_availability_zones=(value) ⇒ Object
-
#preferred_maintenance_window ⇒ String?
Specifies the weekly time range during which maintenance on the cluster is performed.
- #preferred_maintenance_window=(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.
-
#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 single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.
- #snapshot_arns=(value) ⇒ Object
-
#snapshot_name ⇒ String?
The name of a Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
- #snapshot_name=(value) ⇒ Object
-
#snapshot_retention_limit ⇒ Numeric?
The number of days for which ElastiCache retains automatic snapshots before deleting them.
- #snapshot_retention_limit=(value) ⇒ Object
-
#snapshot_window ⇒ String?
The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard).
- #snapshot_window=(value) ⇒ Object
-
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
-
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
-
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
A list of tags to be added to this resource.
- #tags_raw=(value) ⇒ Object
-
#to_string ⇒ String
Returns a string representation of this construct.
-
#transit_encryption_enabled ⇒ Boolean, ...
A flag that enables in-transit encryption when set to true.
- #transit_encryption_enabled=(value) ⇒ Object
-
#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
-
#vpc_security_group_ids ⇒ Array<String>?
One or more VPC security groups associated with the cluster.
- #vpc_security_group_ids=(value) ⇒ Object
-
#with(*mixins) ⇒ Constructs::IConstruct
Applies one or more mixins to this construct.
Constructor Details
#initialize(scope, id, props) ⇒ CfnCacheCluster
Create a new AWS::ElastiCache::CacheCluster.
18 19 20 21 22 23 24 |
# File 'elasticache/cfn_cache_cluster.rb', line 18 def initialize(scope, id, props) props = props.is_a?(Hash) ? ::AWSCDK::Elasticache::CfnCacheClusterProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2FjaGUuQ2ZuQ2FjaGVDbHVzdGVyUHJvcHMifQ==")), "props") Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props) end |
Class Method Details
.CFN_RESOURCE_TYPE_NAME ⇒ String
The CloudFormation resource type name for this resource class.
201 202 203 |
# File 'elasticache/cfn_cache_cluster.rb', line 201 def self.CFN_RESOURCE_TYPE_NAME() Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_elasticache.CfnCacheCluster", "CFN_RESOURCE_TYPE_NAME") end |
.is_cfn_cache_cluster(x) ⇒ Boolean
Checks whether the given object is a CfnCacheCluster.
103 104 105 106 |
# File 'elasticache/cfn_cache_cluster.rb', line 103 def self.is_cfn_cache_cluster(x) Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x") Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticache.CfnCacheCluster", "isCfnCacheCluster", [x]) end |
.jsii_overridable_methods ⇒ Object
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 93 94 95 96 97 |
# File 'elasticache/cfn_cache_cluster.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_configuration_endpoint => { kind: :property, name: "attrConfigurationEndpoint", is_optional: false }, :attr_configuration_endpoint_address => { kind: :property, name: "attrConfigurationEndpointAddress", is_optional: false }, :attr_configuration_endpoint_port => { kind: :property, name: "attrConfigurationEndpointPort", is_optional: false }, :attr_redis_endpoint => { kind: :property, name: "attrRedisEndpoint", is_optional: false }, :attr_redis_endpoint_address => { kind: :property, name: "attrRedisEndpointAddress", is_optional: false }, :attr_redis_endpoint_port => { kind: :property, name: "attrRedisEndpointPort", is_optional: false }, :cache_cluster_ref => { kind: :property, name: "cacheClusterRef", is_optional: false }, :tags => { kind: :property, name: "tags", is_optional: false }, :cache_node_type => { kind: :property, name: "cacheNodeType", is_optional: false }, :engine => { kind: :property, name: "engine", is_optional: false }, :num_cache_nodes => { kind: :property, name: "numCacheNodes", is_optional: false }, :auto_minor_version_upgrade => { kind: :property, name: "autoMinorVersionUpgrade", is_optional: true }, :az_mode => { kind: :property, name: "azMode", is_optional: true }, :cache_parameter_group_name => { kind: :property, name: "cacheParameterGroupName", is_optional: true }, :cache_security_group_names => { kind: :property, name: "cacheSecurityGroupNames", is_optional: true }, :cache_subnet_group_name => { kind: :property, name: "cacheSubnetGroupName", is_optional: true }, :cluster_name => { kind: :property, name: "clusterName", is_optional: true }, :engine_version => { kind: :property, name: "engineVersion", is_optional: true }, :ip_discovery => { kind: :property, name: "ipDiscovery", is_optional: true }, :log_delivery_configurations => { kind: :property, name: "logDeliveryConfigurations", is_optional: true }, :network_type => { kind: :property, name: "networkType", is_optional: true }, :notification_topic_arn => { kind: :property, name: "notificationTopicArn", is_optional: true }, :port => { kind: :property, name: "port", is_optional: true }, :preferred_availability_zone => { kind: :property, name: "preferredAvailabilityZone", is_optional: true }, :preferred_availability_zones => { kind: :property, name: "preferredAvailabilityZones", is_optional: true }, :preferred_maintenance_window => { kind: :property, name: "preferredMaintenanceWindow", 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 }, :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true }, :transit_encryption_enabled => { kind: :property, name: "transitEncryptionEnabled", is_optional: true }, :vpc_security_group_ids => { kind: :property, name: "vpcSecurityGroupIds", 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).
599 600 601 602 |
# File 'elasticache/cfn_cache_cluster.rb', line 599 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.
611 612 613 614 |
# File 'elasticache/cfn_cache_cluster.rb', line 611 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.
621 622 623 624 |
# File 'elasticache/cfn_cache_cluster.rb', line 621 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.
632 633 634 635 636 |
# File 'elasticache/cfn_cache_cluster.rb', line 632 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.
689 690 691 692 693 |
# File 'elasticache/cfn_cache_cluster.rb', line 689 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.
699 700 701 702 |
# File 'elasticache/cfn_cache_cluster.rb', line 699 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).
711 712 713 714 715 |
# File 'elasticache/cfn_cache_cluster.rb', line 711 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.
724 725 726 727 |
# File 'elasticache/cfn_cache_cluster.rb', line 724 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:
746 747 748 749 750 751 |
# File 'elasticache/cfn_cache_cluster.rb', line 746 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_configuration_endpoint ⇒ AWSCDK::IResolvable
206 207 208 |
# File 'elasticache/cfn_cache_cluster.rb', line 206 def attr_configuration_endpoint() jsii_get_property("attrConfigurationEndpoint") end |
#attr_configuration_endpoint_address ⇒ String
The DNS hostname of the cache node.
Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore,
Fn::GetAttreturns a value for this attribute only if the replication group is clustered. Otherwise,Fn::GetAttfails.
215 216 217 |
# File 'elasticache/cfn_cache_cluster.rb', line 215 def attr_configuration_endpoint_address() jsii_get_property("attrConfigurationEndpointAddress") end |
#attr_configuration_endpoint_port ⇒ String
The port number of the configuration endpoint for the Memcached cache cluster.
Valkey and Redis OSS (cluster mode disabled) replication groups don't have this attribute. Therefore,
Fn::GetAttreturns a value for this attribute only if the replication group is clustered. Otherwise,Fn::GetAttfails.
224 225 226 |
# File 'elasticache/cfn_cache_cluster.rb', line 224 def attr_configuration_endpoint_port() jsii_get_property("attrConfigurationEndpointPort") end |
#attr_redis_endpoint ⇒ AWSCDK::IResolvable
229 230 231 |
# File 'elasticache/cfn_cache_cluster.rb', line 229 def attr_redis_endpoint() jsii_get_property("attrRedisEndpoint") end |
#attr_redis_endpoint_address ⇒ String
The DNS address of the configuration endpoint for the Valkey or Redis OSS cache cluster.
236 237 238 |
# File 'elasticache/cfn_cache_cluster.rb', line 236 def attr_redis_endpoint_address() jsii_get_property("attrRedisEndpointAddress") end |
#attr_redis_endpoint_port ⇒ String
The port number of the configuration endpoint for the Valkey or Redis OSS cache cluster.
243 244 245 |
# File 'elasticache/cfn_cache_cluster.rb', line 243 def attr_redis_endpoint_port() jsii_get_property("attrRedisEndpointPort") end |
#auto_minor_version_upgrade ⇒ Boolean, ...
If you are running Valkey 7.2 or later, or Redis OSS engine version 6.0 or later, set this parameter to yes if you want to opt-in to the next minor version upgrade campaign. This parameter is disabled for previous versions.
300 301 302 |
# File 'elasticache/cfn_cache_cluster.rb', line 300 def auto_minor_version_upgrade() jsii_get_property("autoMinorVersionUpgrade") end |
#auto_minor_version_upgrade=(value) ⇒ Object
304 305 306 307 |
# File 'elasticache/cfn_cache_cluster.rb', line 304 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 |
#az_mode ⇒ String?
Specifies whether the nodes in this Memcached cluster are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region.
312 313 314 |
# File 'elasticache/cfn_cache_cluster.rb', line 312 def az_mode() jsii_get_property("azMode") end |
#az_mode=(value) ⇒ Object
316 317 318 319 |
# File 'elasticache/cfn_cache_cluster.rb', line 316 def az_mode=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "azMode") unless value.nil? jsii_set_property("azMode", value) end |
#cache_cluster_ref ⇒ AWSCDK::Interfaces::AWSElasticache::CacheClusterReference
A reference to a CacheCluster resource.
250 251 252 |
# File 'elasticache/cfn_cache_cluster.rb', line 250 def cache_cluster_ref() jsii_get_property("cacheClusterRef") end |
#cache_node_type ⇒ String
The compute and memory capacity of the nodes in the node group (shard).
264 265 266 |
# File 'elasticache/cfn_cache_cluster.rb', line 264 def cache_node_type() jsii_get_property("cacheNodeType") end |
#cache_node_type=(value) ⇒ Object
268 269 270 271 |
# File 'elasticache/cfn_cache_cluster.rb', line 268 def cache_node_type=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheNodeType") jsii_set_property("cacheNodeType", value) end |
#cache_parameter_group_name ⇒ String?
The name of the parameter group to associate with this cluster.
324 325 326 |
# File 'elasticache/cfn_cache_cluster.rb', line 324 def cache_parameter_group_name() jsii_get_property("cacheParameterGroupName") end |
#cache_parameter_group_name=(value) ⇒ Object
328 329 330 331 |
# File 'elasticache/cfn_cache_cluster.rb', line 328 def cache_parameter_group_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheParameterGroupName") unless value.nil? jsii_set_property("cacheParameterGroupName", value) end |
#cache_security_group_names ⇒ Array<String>?
this property has been deprecated
A list of security group names to associate with this cluster.
337 338 339 |
# File 'elasticache/cfn_cache_cluster.rb', line 337 def cache_security_group_names() jsii_get_property("cacheSecurityGroupNames") end |
#cache_security_group_names=(value) ⇒ Object
341 342 343 344 |
# File 'elasticache/cfn_cache_cluster.rb', line 341 def cache_security_group_names=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "cacheSecurityGroupNames") unless value.nil? jsii_set_property("cacheSecurityGroupNames", value) end |
#cache_subnet_group_name ⇒ String?
The name of the subnet group to be used for the cluster.
349 350 351 |
# File 'elasticache/cfn_cache_cluster.rb', line 349 def cache_subnet_group_name() jsii_get_property("cacheSubnetGroupName") end |
#cache_subnet_group_name=(value) ⇒ Object
353 354 355 356 |
# File 'elasticache/cfn_cache_cluster.rb', line 353 def cache_subnet_group_name=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cacheSubnetGroupName") unless value.nil? jsii_set_property("cacheSubnetGroupName", value) end |
#cfn_options ⇒ AWSCDK::ICfnResourceOptions
Options for this resource, such as condition, update policy etc.
154 155 156 |
# File 'elasticache/cfn_cache_cluster.rb', line 154 def () jsii_get_property("cfnOptions") end |
#cfn_properties ⇒ Hash{String => Object}
159 160 161 |
# File 'elasticache/cfn_cache_cluster.rb', line 159 def cfn_properties() jsii_get_property("cfnProperties") end |
#cfn_property_name(cdk_property_name) ⇒ String?
755 756 757 758 |
# File 'elasticache/cfn_cache_cluster.rb', line 755 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}
164 165 166 |
# File 'elasticache/cfn_cache_cluster.rb', line 164 def cfn_property_names() jsii_get_property("cfnPropertyNames") end |
#cfn_resource_type ⇒ String
AWS resource type.
171 172 173 |
# File 'elasticache/cfn_cache_cluster.rb', line 171 def cfn_resource_type() jsii_get_property("cfnResourceType") end |
#cluster_name ⇒ String?
A name for the cache cluster.
361 362 363 |
# File 'elasticache/cfn_cache_cluster.rb', line 361 def cluster_name() jsii_get_property("clusterName") end |
#cluster_name=(value) ⇒ Object
365 366 367 368 |
# File 'elasticache/cfn_cache_cluster.rb', line 365 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 |
#creation_stack ⇒ Array<String>
116 117 118 |
# File 'elasticache/cfn_cache_cluster.rb', line 116 def creation_stack() jsii_get_property("creationStack") end |
#engine ⇒ String
The name of the cache engine to be used for this cluster.
276 277 278 |
# File 'elasticache/cfn_cache_cluster.rb', line 276 def engine() jsii_get_property("engine") end |
#engine=(value) ⇒ Object
280 281 282 283 |
# File 'elasticache/cfn_cache_cluster.rb', line 280 def engine=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "engine") jsii_set_property("engine", value) end |
#engine_version ⇒ String?
The version number of the cache engine to be used for this cluster.
373 374 375 |
# File 'elasticache/cfn_cache_cluster.rb', line 373 def engine_version() jsii_get_property("engineVersion") end |
#engine_version=(value) ⇒ Object
377 378 379 380 |
# File 'elasticache/cfn_cache_cluster.rb', line 377 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
176 177 178 |
# File 'elasticache/cfn_cache_cluster.rb', line 176 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.
768 769 770 771 772 |
# File 'elasticache/cfn_cache_cluster.rb', line 768 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.
779 780 781 782 |
# File 'elasticache/cfn_cache_cluster.rb', line 779 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.
849 850 851 852 |
# File 'elasticache/cfn_cache_cluster.rb', line 849 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 network type you choose when modifying a cluster, either ipv4 | ipv6 .
385 386 387 |
# File 'elasticache/cfn_cache_cluster.rb', line 385 def ip_discovery() jsii_get_property("ipDiscovery") end |
#ip_discovery=(value) ⇒ Object
389 390 391 392 |
# File 'elasticache/cfn_cache_cluster.rb', line 389 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 |
#log_delivery_configurations ⇒ AWSCDK::IResolvable, ...
Specifies the destination, format and type of the logs.
397 398 399 |
# File 'elasticache/cfn_cache_cluster.rb', line 397 def log_delivery_configurations() jsii_get_property("logDeliveryConfigurations") end |
#log_delivery_configurations=(value) ⇒ Object
401 402 403 404 |
# File 'elasticache/cfn_cache_cluster.rb', line 401 def log_delivery_configurations=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2FjaGUuQ2ZuQ2FjaGVDbHVzdGVyLkxvZ0RlbGl2ZXJ5Q29uZmlndXJhdGlvblJlcXVlc3RQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "logDeliveryConfigurations") unless value.nil? jsii_set_property("logDeliveryConfigurations", 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).
128 129 130 |
# File 'elasticache/cfn_cache_cluster.rb', line 128 def logical_id() jsii_get_property("logicalId") end |
#network_type ⇒ String?
Must be either ipv4 | ipv6 | dual_stack .
409 410 411 |
# File 'elasticache/cfn_cache_cluster.rb', line 409 def network_type() jsii_get_property("networkType") end |
#network_type=(value) ⇒ Object
413 414 415 416 |
# File 'elasticache/cfn_cache_cluster.rb', line 413 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.
111 112 113 |
# File 'elasticache/cfn_cache_cluster.rb', line 111 def node() jsii_get_property("node") end |
#notification_topic_arn ⇒ String?
The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic to which notifications are sent.
421 422 423 |
# File 'elasticache/cfn_cache_cluster.rb', line 421 def notification_topic_arn() jsii_get_property("notificationTopicArn") end |
#notification_topic_arn=(value) ⇒ Object
425 426 427 428 |
# File 'elasticache/cfn_cache_cluster.rb', line 425 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 |
#num_cache_nodes ⇒ Numeric
The number of cache nodes that the cache cluster should have.
288 289 290 |
# File 'elasticache/cfn_cache_cluster.rb', line 288 def num_cache_nodes() jsii_get_property("numCacheNodes") end |
#num_cache_nodes=(value) ⇒ Object
292 293 294 295 |
# File 'elasticache/cfn_cache_cluster.rb', line 292 def num_cache_nodes=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numCacheNodes") jsii_set_property("numCacheNodes", 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.
790 791 792 |
# File 'elasticache/cfn_cache_cluster.rb', line 790 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.
797 798 799 |
# File 'elasticache/cfn_cache_cluster.rb', line 797 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.
590 591 592 593 |
# File 'elasticache/cfn_cache_cluster.rb', line 590 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 |
#port ⇒ Numeric?
The port number on which each of the cache nodes accepts connections.
433 434 435 |
# File 'elasticache/cfn_cache_cluster.rb', line 433 def port() jsii_get_property("port") end |
#port=(value) ⇒ Object
437 438 439 440 |
# File 'elasticache/cfn_cache_cluster.rb', line 437 def port=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless value.nil? jsii_set_property("port", value) end |
#preferred_availability_zone ⇒ String?
The EC2 Availability Zone in which the cluster is created.
445 446 447 |
# File 'elasticache/cfn_cache_cluster.rb', line 445 def preferred_availability_zone() jsii_get_property("preferredAvailabilityZone") end |
#preferred_availability_zone=(value) ⇒ Object
449 450 451 452 |
# File 'elasticache/cfn_cache_cluster.rb', line 449 def preferred_availability_zone=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "preferredAvailabilityZone") unless value.nil? jsii_set_property("preferredAvailabilityZone", value) end |
#preferred_availability_zones ⇒ Array<String>?
A list of the Availability Zones in which cache nodes are created.
457 458 459 |
# File 'elasticache/cfn_cache_cluster.rb', line 457 def preferred_availability_zones() jsii_get_property("preferredAvailabilityZones") end |
#preferred_availability_zones=(value) ⇒ Object
461 462 463 464 |
# File 'elasticache/cfn_cache_cluster.rb', line 461 def preferred_availability_zones=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "preferredAvailabilityZones") unless value.nil? jsii_set_property("preferredAvailabilityZones", value) end |
#preferred_maintenance_window ⇒ String?
Specifies the weekly time range during which maintenance on the cluster is performed.
469 470 471 |
# File 'elasticache/cfn_cache_cluster.rb', line 469 def preferred_maintenance_window() jsii_get_property("preferredMaintenanceWindow") end |
#preferred_maintenance_window=(value) ⇒ Object
473 474 475 476 |
# File 'elasticache/cfn_cache_cluster.rb', line 473 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 }).
147 148 149 |
# File 'elasticache/cfn_cache_cluster.rb', line 147 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.
808 809 810 811 |
# File 'elasticache/cfn_cache_cluster.rb', line 808 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}
815 816 817 818 |
# File 'elasticache/cfn_cache_cluster.rb', line 815 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.
825 826 827 828 829 |
# File 'elasticache/cfn_cache_cluster.rb', line 825 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 |
#should_synthesize ⇒ Boolean
Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
834 835 836 |
# File 'elasticache/cfn_cache_cluster.rb', line 834 def should_synthesize() jsii_call_method("shouldSynthesize", []) end |
#snapshot_arns ⇒ Array<String>?
A single-element string list containing an Amazon Resource Name (ARN) that uniquely identifies a Valkey or Redis OSS RDB snapshot file stored in Amazon S3.
481 482 483 |
# File 'elasticache/cfn_cache_cluster.rb', line 481 def snapshot_arns() jsii_get_property("snapshotArns") end |
#snapshot_arns=(value) ⇒ Object
485 486 487 488 |
# File 'elasticache/cfn_cache_cluster.rb', line 485 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 Valkey or Redis OSS snapshot from which to restore data into the new node group (shard).
493 494 495 |
# File 'elasticache/cfn_cache_cluster.rb', line 493 def snapshot_name() jsii_get_property("snapshotName") end |
#snapshot_name=(value) ⇒ Object
497 498 499 500 |
# File 'elasticache/cfn_cache_cluster.rb', line 497 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 ElastiCache retains automatic snapshots before deleting them.
505 506 507 |
# File 'elasticache/cfn_cache_cluster.rb', line 505 def snapshot_retention_limit() jsii_get_property("snapshotRetentionLimit") end |
#snapshot_retention_limit=(value) ⇒ Object
509 510 511 512 |
# File 'elasticache/cfn_cache_cluster.rb', line 509 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 ElastiCache begins taking a daily snapshot of your node group (shard).
517 518 519 |
# File 'elasticache/cfn_cache_cluster.rb', line 517 def snapshot_window() jsii_get_property("snapshotWindow") end |
#snapshot_window=(value) ⇒ Object
521 522 523 524 |
# File 'elasticache/cfn_cache_cluster.rb', line 521 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 |
#stack ⇒ AWSCDK::Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
137 138 139 |
# File 'elasticache/cfn_cache_cluster.rb', line 137 def stack() jsii_get_property("stack") end |
#tags ⇒ AWSCDK::TagManager
Tag Manager which manages the tags for this resource.
257 258 259 |
# File 'elasticache/cfn_cache_cluster.rb', line 257 def () jsii_get_property("tags") end |
#tags_raw ⇒ Array<AWSCDK::CfnTag>?
A list of tags to be added to this resource.
529 530 531 |
# File 'elasticache/cfn_cache_cluster.rb', line 529 def () jsii_get_property("tagsRaw") end |
#tags_raw=(value) ⇒ Object
533 534 535 536 537 |
# File 'elasticache/cfn_cache_cluster.rb', line 533 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 |
#to_string ⇒ String
Returns a string representation of this construct.
566 567 568 |
# File 'elasticache/cfn_cache_cluster.rb', line 566 def to_string() jsii_call_method("toString", []) end |
#transit_encryption_enabled ⇒ Boolean, ...
A flag that enables in-transit encryption when set to true.
542 543 544 |
# File 'elasticache/cfn_cache_cluster.rb', line 542 def transit_encryption_enabled() jsii_get_property("transitEncryptionEnabled") end |
#transit_encryption_enabled=(value) ⇒ Object
546 547 548 549 |
# File 'elasticache/cfn_cache_cluster.rb', line 546 def transit_encryption_enabled=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "transitEncryptionEnabled") unless value.nil? jsii_set_property("transitEncryptionEnabled", value) 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.
184 185 186 |
# File 'elasticache/cfn_cache_cluster.rb', line 184 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.
194 195 196 |
# File 'elasticache/cfn_cache_cluster.rb', line 194 def updated_properties() jsii_get_property("updatedProperties") end |
#validate_properties(_properties) ⇒ void
This method returns an undefined value.
840 841 842 843 |
# File 'elasticache/cfn_cache_cluster.rb', line 840 def validate_properties(_properties) Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties") jsii_call_method("validateProperties", [_properties]) end |
#vpc_security_group_ids ⇒ Array<String>?
One or more VPC security groups associated with the cluster.
554 555 556 |
# File 'elasticache/cfn_cache_cluster.rb', line 554 def vpc_security_group_ids() jsii_get_property("vpcSecurityGroupIds") end |
#vpc_security_group_ids=(value) ⇒ Object
558 559 560 561 |
# File 'elasticache/cfn_cache_cluster.rb', line 558 def vpc_security_group_ids=(value) Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "vpcSecurityGroupIds") unless value.nil? jsii_set_property("vpcSecurityGroupIds", 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.
579 580 581 582 583 584 |
# File 'elasticache/cfn_cache_cluster.rb', line 579 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 |