Class: AWSCDK::Elasticache::CfnServerlessCache

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSElasticache::IServerlessCacheRef
Defined in:
elasticache/cfn_serverless_cache.rb

Overview

The resource representing a serverless cache.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnServerlessCache

Create a new AWS::ElastiCache::ServerlessCache.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Elasticache::CfnServerlessCacheProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'elasticache/cfn_serverless_cache.rb', line 18

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

Class Method Details

.arn_for_serverless_cache(resource) ⇒ String

Parameters:

Returns:

  • (String) 


95
96
97
98
 
# File 'elasticache/cfn_serverless_cache.rb', line 95

def self.arn_for_serverless_cache(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lbGFzdGljYWNoZS5JU2VydmVybGVzc0NhY2hlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticache.CfnServerlessCache", "arnForServerlessCache", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


228
229
230
 
# File 'elasticache/cfn_serverless_cache.rb', line 228

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

.from_serverless_cache_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSElasticache::IServerlessCacheRef

Creates a new IServerlessCacheRef from an ARN.

Parameters:

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

Returns:



106
107
108
109
110
111
 
# File 'elasticache/cfn_serverless_cache.rb', line 106

def self.from_serverless_cache_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_elasticache.CfnServerlessCache", "fromServerlessCacheArn", [scope, id, arn])
end

.from_serverless_cache_name(scope, id, serverless_cache_name) ⇒ AWSCDK::Interfaces::AWSElasticache::IServerlessCacheRef

Creates a new IServerlessCacheRef from a serverlessCacheName.

Parameters:

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

Returns:



119
120
121
122
123
124
 
# File 'elasticache/cfn_serverless_cache.rb', line 119

def self.from_serverless_cache_name(scope, id, serverless_cache_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(serverless_cache_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverlessCacheName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticache.CfnServerlessCache", "fromServerlessCacheName", [scope, id, serverless_cache_name])
end

.is_cfn_serverless_cache(x) ⇒ Boolean

Checks whether the given object is a CfnServerlessCache.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


130
131
132
133
 
# File 'elasticache/cfn_serverless_cache.rb', line 130

def self.is_cfn_serverless_cache(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_elasticache.CfnServerlessCache", "isCfnServerlessCache", [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
 
# File 'elasticache/cfn_serverless_cache.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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_create_time => { kind: :property, name: "attrCreateTime", is_optional: false },
    :attr_endpoint_address => { kind: :property, name: "attrEndpointAddress", is_optional: false },
    :attr_endpoint_port => { kind: :property, name: "attrEndpointPort", is_optional: false },
    :attr_full_engine_version => { kind: :property, name: "attrFullEngineVersion", is_optional: false },
    :attr_reader_endpoint_address => { kind: :property, name: "attrReaderEndpointAddress", is_optional: false },
    :attr_reader_endpoint_port => { kind: :property, name: "attrReaderEndpointPort", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :serverless_cache_ref => { kind: :property, name: "serverlessCacheRef", is_optional: false },
    :engine => { kind: :property, name: "engine", is_optional: false },
    :serverless_cache_name => { kind: :property, name: "serverlessCacheName", is_optional: false },
    :cache_usage_limits => { kind: :property, name: "cacheUsageLimits", is_optional: true },
    :daily_snapshot_time => { kind: :property, name: "dailySnapshotTime", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :endpoint => { kind: :property, name: "endpoint", is_optional: true },
    :final_snapshot_name => { kind: :property, name: "finalSnapshotName", is_optional: true },
    :kms_key_id => { kind: :property, name: "kmsKeyId", is_optional: true },
    :major_engine_version => { kind: :property, name: "majorEngineVersion", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :reader_endpoint => { kind: :property, name: "readerEndpoint", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :snapshot_arns_to_restore => { kind: :property, name: "snapshotArnsToRestore", is_optional: true },
    :snapshot_retention_limit => { kind: :property, name: "snapshotRetentionLimit", is_optional: true },
    :subnet_ids => { kind: :property, name: "subnetIds", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :user_group_id => { kind: :property, name: "userGroupId", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



548
549
550
551
 
# File 'elasticache/cfn_serverless_cache.rb', line 548

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

#add_dependency(target) ⇒ void

This method returns an undefined value.

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

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

Parameters:



560
561
562
563
 
# File 'elasticache/cfn_serverless_cache.rb', line 560

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

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

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

Parameters:



570
571
572
573
 
# File 'elasticache/cfn_serverless_cache.rb', line 570

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

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



581
582
583
584
585
 
# File 'elasticache/cfn_serverless_cache.rb', line 581

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

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

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

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

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

For example,

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

would add the overrides

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

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

Parameters:

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


638
639
640
641
642
 
# File 'elasticache/cfn_serverless_cache.rb', line 638

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

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

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

Parameters:

  • property_path (String) —

    The path to the property.



648
649
650
651
 
# File 'elasticache/cfn_serverless_cache.rb', line 648

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

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

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

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



660
661
662
663
664
 
# File 'elasticache/cfn_serverless_cache.rb', line 660

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

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

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

Parameters:



673
674
675
676
 
# File 'elasticache/cfn_serverless_cache.rb', line 673

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

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

This method returns an undefined value.

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

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

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

Parameters:

See Also:



695
696
697
698
699
700
 
# File 'elasticache/cfn_serverless_cache.rb', line 695

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

#attr_arn ⇒ String

The Amazon Resource Name (ARN) of the serverless cache.

Returns:

  • (String) 


235
236
237
 
# File 'elasticache/cfn_serverless_cache.rb', line 235

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_create_time ⇒ String

When the serverless cache was created.

Returns:

  • (String) 


242
243
244
 
# File 'elasticache/cfn_serverless_cache.rb', line 242

def attr_create_time()
  jsii_get_property("attrCreateTime")
end

#attr_endpoint_address ⇒ String

The DNS hostname of the cache node.

Returns:

  • (String) 


249
250
251
 
# File 'elasticache/cfn_serverless_cache.rb', line 249

def attr_endpoint_address()
  jsii_get_property("attrEndpointAddress")
end

#attr_endpoint_port ⇒ String

The port number that the cache engine is listening on.

Returns:

  • (String) 


256
257
258
 
# File 'elasticache/cfn_serverless_cache.rb', line 256

def attr_endpoint_port()
  jsii_get_property("attrEndpointPort")
end

#attr_full_engine_version ⇒ String

The name and version number of the engine the serverless cache is compatible with.

Returns:

  • (String) 


263
264
265
 
# File 'elasticache/cfn_serverless_cache.rb', line 263

def attr_full_engine_version()
  jsii_get_property("attrFullEngineVersion")
end

#attr_reader_endpoint_address ⇒ String

The DNS hostname of the cache node.

Returns:

  • (String) 


270
271
272
 
# File 'elasticache/cfn_serverless_cache.rb', line 270

def attr_reader_endpoint_address()
  jsii_get_property("attrReaderEndpointAddress")
end

#attr_reader_endpoint_port ⇒ String

The port number that the cache engine is listening on.

Returns:

  • (String) 


277
278
279
 
# File 'elasticache/cfn_serverless_cache.rb', line 277

def attr_reader_endpoint_port()
  jsii_get_property("attrReaderEndpointPort")
end

#attr_status ⇒ String

The current status of the serverless cache.

The allowed values are CREATING, AVAILABLE, DELETING, CREATE-FAILED and MODIFYING.

Returns:

  • (String) 


286
287
288
 
# File 'elasticache/cfn_serverless_cache.rb', line 286

def attr_status()
  jsii_get_property("attrStatus")
end

#cache_usage_limits ⇒ AWSCDK::IResolvable, ...

The cache usage limit for the serverless cache.

Returns:



331
332
333
 
# File 'elasticache/cfn_serverless_cache.rb', line 331

def cache_usage_limits()
  jsii_get_property("cacheUsageLimits")
end

#cache_usage_limits=(value) ⇒ Object 



335
336
337
338
339
 
# File 'elasticache/cfn_serverless_cache.rb', line 335

def cache_usage_limits=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Elasticache::CfnServerlessCache::CacheUsageLimitsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljYWNoZS5DZm5TZXJ2ZXJsZXNzQ2FjaGUuQ2FjaGVVc2FnZUxpbWl0c1Byb3BlcnR5In1dfX0=")), "cacheUsageLimits") unless value.nil?
  jsii_set_property("cacheUsageLimits", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



293
294
295
 
# File 'elasticache/cfn_serverless_cache.rb', line 293

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



181
182
183
 
# File 'elasticache/cfn_serverless_cache.rb', line 181

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


186
187
188
 
# File 'elasticache/cfn_serverless_cache.rb', line 186

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


704
705
706
707
 
# File 'elasticache/cfn_serverless_cache.rb', line 704

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

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


191
192
193
 
# File 'elasticache/cfn_serverless_cache.rb', line 191

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


198
199
200
 
# File 'elasticache/cfn_serverless_cache.rb', line 198

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


143
144
145
 
# File 'elasticache/cfn_serverless_cache.rb', line 143

def creation_stack()
  jsii_get_property("creationStack")
end

#daily_snapshot_time ⇒ String?

The daily time that a cache snapshot will be created.

Returns:

  • (String, nil) 


344
345
346
 
# File 'elasticache/cfn_serverless_cache.rb', line 344

def daily_snapshot_time()
  jsii_get_property("dailySnapshotTime")
end

#daily_snapshot_time=(value) ⇒ Object 



348
349
350
351
 
# File 'elasticache/cfn_serverless_cache.rb', line 348

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

#description ⇒ String?

A description of the serverless cache.

Returns:

  • (String, nil) 


356
357
358
 
# File 'elasticache/cfn_serverless_cache.rb', line 356

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



360
361
362
363
 
# File 'elasticache/cfn_serverless_cache.rb', line 360

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

#endpoint ⇒ AWSCDK::IResolvable, ...

Represents the information required for client programs to connect to a cache node.

Returns:



368
369
370
 
# File 'elasticache/cfn_serverless_cache.rb', line 368

def endpoint()
  jsii_get_property("endpoint")
end

#endpoint=(value) ⇒ Object 



372
373
374
375
376
 
# File 'elasticache/cfn_serverless_cache.rb', line 372

def endpoint=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Elasticache::CfnServerlessCache::EndpointProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljYWNoZS5DZm5TZXJ2ZXJsZXNzQ2FjaGUuRW5kcG9pbnRQcm9wZXJ0eSJ9XX19")), "endpoint") unless value.nil?
  jsii_set_property("endpoint", value)
end

#engine ⇒ String

The engine the serverless cache is compatible with.

Returns:

  • (String) 


307
308
309
 
# File 'elasticache/cfn_serverless_cache.rb', line 307

def engine()
  jsii_get_property("engine")
end

#engine=(value) ⇒ Object 



311
312
313
314
 
# File 'elasticache/cfn_serverless_cache.rb', line 311

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



203
204
205
 
# File 'elasticache/cfn_serverless_cache.rb', line 203

def env()
  jsii_get_property("env")
end

#final_snapshot_name ⇒ String?

The name of the final snapshot taken of a cache before the cache is deleted.

Returns:

  • (String, nil) 


381
382
383
 
# File 'elasticache/cfn_serverless_cache.rb', line 381

def final_snapshot_name()
  jsii_get_property("finalSnapshotName")
end

#final_snapshot_name=(value) ⇒ Object 



385
386
387
388
 
# File 'elasticache/cfn_serverless_cache.rb', line 385

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.

Parameters:

Returns:



717
718
719
720
721
 
# File 'elasticache/cfn_serverless_cache.rb', line 717

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

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



728
729
730
731
 
# File 'elasticache/cfn_serverless_cache.rb', line 728

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

Parameters:



798
799
800
801
 
# File 'elasticache/cfn_serverless_cache.rb', line 798

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

#kms_key_id ⇒ String?

The ID of the AWS Key Management Service (KMS) key that is used to encrypt data at rest in the serverless cache.

Returns:

  • (String, nil) 


393
394
395
 
# File 'elasticache/cfn_serverless_cache.rb', line 393

def kms_key_id()
  jsii_get_property("kmsKeyId")
end

#kms_key_id=(value) ⇒ Object 



397
398
399
400
 
# File 'elasticache/cfn_serverless_cache.rb', line 397

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

Returns:

  • (String) 


155
156
157
 
# File 'elasticache/cfn_serverless_cache.rb', line 155

def logical_id()
  jsii_get_property("logicalId")
end

#major_engine_version ⇒ String?

The version number of the engine the serverless cache is compatible with.

Returns:

  • (String, nil) 


405
406
407
 
# File 'elasticache/cfn_serverless_cache.rb', line 405

def major_engine_version()
  jsii_get_property("majorEngineVersion")
end

#major_engine_version=(value) ⇒ Object 



409
410
411
412
 
# File 'elasticache/cfn_serverless_cache.rb', line 409

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

#network_type ⇒ String?

The network type for the serverless cache.

Returns:

  • (String, nil) 


417
418
419
 
# File 'elasticache/cfn_serverless_cache.rb', line 417

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



421
422
423
424
 
# File 'elasticache/cfn_serverless_cache.rb', line 421

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


138
139
140
 
# File 'elasticache/cfn_serverless_cache.rb', line 138

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

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

Returns:



739
740
741
 
# File 'elasticache/cfn_serverless_cache.rb', line 739

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

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

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

Returns:



746
747
748
 
# File 'elasticache/cfn_serverless_cache.rb', line 746

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

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

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

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



539
540
541
542
 
# File 'elasticache/cfn_serverless_cache.rb', line 539

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

#reader_endpoint ⇒ AWSCDK::IResolvable, ...

Represents the information required for client programs to connect to a cache node.

Returns:



429
430
431
 
# File 'elasticache/cfn_serverless_cache.rb', line 429

def reader_endpoint()
  jsii_get_property("readerEndpoint")
end

#reader_endpoint=(value) ⇒ Object 



433
434
435
436
437
 
# File 'elasticache/cfn_serverless_cache.rb', line 433

def reader_endpoint=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Elasticache::CfnServerlessCache::EndpointProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljYWNoZS5DZm5TZXJ2ZXJsZXNzQ2FjaGUuRW5kcG9pbnRQcm9wZXJ0eSJ9XX19")), "readerEndpoint") unless value.nil?
  jsii_set_property("readerEndpoint", value)
end

#ref ⇒ String

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

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

Returns:

  • (String) 


174
175
176
 
# File 'elasticache/cfn_serverless_cache.rb', line 174

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

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

Parameters:



757
758
759
760
 
# File 'elasticache/cfn_serverless_cache.rb', line 757

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

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

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


764
765
766
767
 
# File 'elasticache/cfn_serverless_cache.rb', line 764

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

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



774
775
776
777
778
 
# File 'elasticache/cfn_serverless_cache.rb', line 774

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>?

The IDs of the EC2 security groups associated with the serverless cache.

Returns:

  • (Array<String>, nil) 


442
443
444
 
# File 'elasticache/cfn_serverless_cache.rb', line 442

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



446
447
448
449
 
# File 'elasticache/cfn_serverless_cache.rb', line 446

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

#serverless_cache_name ⇒ String

The unique identifier of the serverless cache.

Returns:

  • (String) 


319
320
321
 
# File 'elasticache/cfn_serverless_cache.rb', line 319

def serverless_cache_name()
  jsii_get_property("serverlessCacheName")
end

#serverless_cache_name=(value) ⇒ Object 



323
324
325
326
 
# File 'elasticache/cfn_serverless_cache.rb', line 323

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

#serverless_cache_ref ⇒ AWSCDK::Interfaces::AWSElasticache::ServerlessCacheReference

A reference to a ServerlessCache resource.

Returns:



300
301
302
 
# File 'elasticache/cfn_serverless_cache.rb', line 300

def serverless_cache_ref()
  jsii_get_property("serverlessCacheRef")
end

#should_synthesize ⇒ Boolean

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

Returns:

  • (Boolean) —

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



783
784
785
 
# File 'elasticache/cfn_serverless_cache.rb', line 783

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

#snapshot_arns_to_restore ⇒ Array<String>?

The ARN of the snapshot from which to restore data into the new cache.

Returns:

  • (Array<String>, nil) 


454
455
456
 
# File 'elasticache/cfn_serverless_cache.rb', line 454

def snapshot_arns_to_restore()
  jsii_get_property("snapshotArnsToRestore")
end

#snapshot_arns_to_restore=(value) ⇒ Object 



458
459
460
461
 
# File 'elasticache/cfn_serverless_cache.rb', line 458

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

#snapshot_retention_limit ⇒ Numeric?

The current setting for the number of serverless cache snapshots the system will retain.

Returns:

  • (Numeric, nil) 


466
467
468
 
# File 'elasticache/cfn_serverless_cache.rb', line 466

def snapshot_retention_limit()
  jsii_get_property("snapshotRetentionLimit")
end

#snapshot_retention_limit=(value) ⇒ Object 



470
471
472
473
 
# File 'elasticache/cfn_serverless_cache.rb', line 470

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



164
165
166
 
# File 'elasticache/cfn_serverless_cache.rb', line 164

def stack()
  jsii_get_property("stack")
end

#subnet_ids ⇒ Array<String>?

If no subnet IDs are given and your VPC is in us-west-1, then ElastiCache will select 2 default subnets across AZs in your VPC.

Returns:

  • (Array<String>, nil) 


478
479
480
 
# File 'elasticache/cfn_serverless_cache.rb', line 478

def subnet_ids()
  jsii_get_property("subnetIds")
end

#subnet_ids=(value) ⇒ Object 



482
483
484
485
 
# File 'elasticache/cfn_serverless_cache.rb', line 482

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

#tags ⇒ Array<AWSCDK::CfnTag>?

A list of tags to be added to this resource.

Returns:



490
491
492
 
# File 'elasticache/cfn_serverless_cache.rb', line 490

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



494
495
496
497
498
 
# File 'elasticache/cfn_serverless_cache.rb', line 494

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



515
516
517
 
# File 'elasticache/cfn_serverless_cache.rb', line 515

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

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

Deprecated.

Returns:

  • (Hash{String => Object}) 


211
212
213
 
# File 'elasticache/cfn_serverless_cache.rb', line 211

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

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

Returns:

  • (Hash{String => Object}) 


221
222
223
 
# File 'elasticache/cfn_serverless_cache.rb', line 221

def updated_properties()
  jsii_get_property("updatedProperties")
end

#user_group_id ⇒ String?

The identifier of the user group associated with the serverless cache.

Returns:

  • (String, nil) 


503
504
505
 
# File 'elasticache/cfn_serverless_cache.rb', line 503

def user_group_id()
  jsii_get_property("userGroupId")
end

#user_group_id=(value) ⇒ Object 



507
508
509
510
 
# File 'elasticache/cfn_serverless_cache.rb', line 507

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


789
790
791
792
 
# File 'elasticache/cfn_serverless_cache.rb', line 789

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

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

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

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


528
529
530
531
532
533
 
# File 'elasticache/cfn_serverless_cache.rb', line 528

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