Class: AWSCDK::Timestream::CfnInfluxDBInstance

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSTimestream::IInfluxDBInstanceRef
Defined in:
timestream/cfn_influx_db_instance.rb

Overview

A DB instance is an isolated database environment running in the cloud.

It is the basic building block of Amazon Timestream for InfluxDB. A DB instance can contain multiple user-created databases (or organizations and buckets for the case of InfluxDb 2.x databases), and can be accessed using the same client tools and applications you might use to access a standalone self-managed InfluxDB instance.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnInfluxDBInstance

Create a new AWS::Timestream::InfluxDBInstance.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::Timestream::CfnInfluxDBInstanceProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'timestream/cfn_influx_db_instance.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::Timestream::CfnInfluxDBInstanceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdGltZXN0cmVhbS5DZm5JbmZsdXhEQkluc3RhbmNlUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_influx_db_instance(resource) ⇒ String

Parameters:

Returns:

  • (String) 


98
99
100
101
 
# File 'timestream/cfn_influx_db_instance.rb', line 98

def self.arn_for_influx_db_instance(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c190aW1lc3RyZWFtLklJbmZsdXhEQkluc3RhbmNlUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_timestream.CfnInfluxDBInstance", "arnForInfluxDBInstance", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


205
206
207
 
# File 'timestream/cfn_influx_db_instance.rb', line 205

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

.is_cfn_influx_db_instance(x) ⇒ Boolean

Checks whether the given object is a CfnInfluxDBInstance.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


107
108
109
110
 
# File 'timestream/cfn_influx_db_instance.rb', line 107

def self.is_cfn_influx_db_instance(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_timestream.CfnInfluxDBInstance", "isCfnInfluxDBInstance", [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
 
# File 'timestream/cfn_influx_db_instance.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_availability_zone => { kind: :property, name: "attrAvailabilityZone", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_influx_auth_parameters_secret_arn => { kind: :property, name: "attrInfluxAuthParametersSecretArn", is_optional: false },
    :attr_next_maintenance_time => { kind: :property, name: "attrNextMaintenanceTime", is_optional: false },
    :attr_secondary_availability_zone => { kind: :property, name: "attrSecondaryAvailabilityZone", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :influx_db_instance_ref => { kind: :property, name: "influxDbInstanceRef", is_optional: false },
    :allocated_storage => { kind: :property, name: "allocatedStorage", is_optional: true },
    :bucket => { kind: :property, name: "bucket", is_optional: true },
    :db_instance_type => { kind: :property, name: "dbInstanceType", is_optional: true },
    :db_parameter_group_identifier => { kind: :property, name: "dbParameterGroupIdentifier", is_optional: true },
    :db_storage_type => { kind: :property, name: "dbStorageType", is_optional: true },
    :deployment_type => { kind: :property, name: "deploymentType", is_optional: true },
    :log_delivery_configuration => { kind: :property, name: "logDeliveryConfiguration", is_optional: true },
    :maintenance_schedule => { kind: :property, name: "maintenanceSchedule", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :organization => { kind: :property, name: "organization", is_optional: true },
    :password => { kind: :property, name: "password", is_optional: true },
    :port => { kind: :property, name: "port", is_optional: true },
    :publicly_accessible => { kind: :property, name: "publiclyAccessible", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :username => { kind: :property, name: "username", is_optional: true },
    :vpc_security_group_ids => { kind: :property, name: "vpcSecurityGroupIds", is_optional: true },
    :vpc_subnet_ids => { kind: :property, name: "vpcSubnetIds", 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.



540
541
542
543
 
# File 'timestream/cfn_influx_db_instance.rb', line 540

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:



552
553
554
555
 
# File 'timestream/cfn_influx_db_instance.rb', line 552

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:



562
563
564
565
 
# File 'timestream/cfn_influx_db_instance.rb', line 562

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:



573
574
575
576
577
 
# File 'timestream/cfn_influx_db_instance.rb', line 573

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.


630
631
632
633
634
 
# File 'timestream/cfn_influx_db_instance.rb', line 630

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.



640
641
642
643
 
# File 'timestream/cfn_influx_db_instance.rb', line 640

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.



652
653
654
655
656
 
# File 'timestream/cfn_influx_db_instance.rb', line 652

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

#allocated_storage ⇒ Numeric?

The amount of storage to allocate for your DB storage type in GiB (gibibytes).

Returns:

  • (Numeric, nil) 


288
289
290
 
# File 'timestream/cfn_influx_db_instance.rb', line 288

def allocated_storage()
  jsii_get_property("allocatedStorage")
end

#allocated_storage=(value) ⇒ Object 



292
293
294
295
 
# File 'timestream/cfn_influx_db_instance.rb', line 292

def allocated_storage=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "allocatedStorage") unless value.nil?
  jsii_set_property("allocatedStorage", 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:



665
666
667
668
 
# File 'timestream/cfn_influx_db_instance.rb', line 665

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:



687
688
689
690
691
692
 
# File 'timestream/cfn_influx_db_instance.rb', line 687

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 DB instance.

Returns:

  • (String) 


212
213
214
 
# File 'timestream/cfn_influx_db_instance.rb', line 212

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_availability_zone ⇒ String

The Availability Zone in which the DB instance resides.

Returns:

  • (String) 


219
220
221
 
# File 'timestream/cfn_influx_db_instance.rb', line 219

def attr_availability_zone()
  jsii_get_property("attrAvailabilityZone")
end

#attr_endpoint ⇒ String

The endpoint used to connect to InfluxDB.

The default InfluxDB port is 8086.

Returns:

  • (String) 


228
229
230
 
# File 'timestream/cfn_influx_db_instance.rb', line 228

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_id ⇒ String

A service-generated unique identifier.

Returns:

  • (String) 


235
236
237
 
# File 'timestream/cfn_influx_db_instance.rb', line 235

def attr_id()
  jsii_get_property("attrId")
end

#attr_influx_auth_parameters_secret_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Secrets Manager secret containing the initial InfluxDB authorization parameters.

The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password.

Returns:

  • (String) 


244
245
246
 
# File 'timestream/cfn_influx_db_instance.rb', line 244

def attr_influx_auth_parameters_secret_arn()
  jsii_get_property("attrInfluxAuthParametersSecretArn")
end

#attr_next_maintenance_time ⇒ String

The timestamp of the next scheduled maintenance event.

Returns:

  • (String) 


251
252
253
 
# File 'timestream/cfn_influx_db_instance.rb', line 251

def attr_next_maintenance_time()
  jsii_get_property("attrNextMaintenanceTime")
end

#attr_secondary_availability_zone ⇒ String

Describes an Availability Zone in which the InfluxDB instance is located.

Returns:

  • (String) 


258
259
260
 
# File 'timestream/cfn_influx_db_instance.rb', line 258

def attr_secondary_availability_zone()
  jsii_get_property("attrSecondaryAvailabilityZone")
end

#attr_status ⇒ String

The status of the DB instance.

Valid Values: CREATING | AVAILABLE | DELETING | MODIFYING | UPDATING | DELETED | FAILED

Returns:

  • (String) 


267
268
269
 
# File 'timestream/cfn_influx_db_instance.rb', line 267

def attr_status()
  jsii_get_property("attrStatus")
end

#bucket ⇒ String?

The name of the initial InfluxDB bucket.

Returns:

  • (String, nil) 


300
301
302
 
# File 'timestream/cfn_influx_db_instance.rb', line 300

def bucket()
  jsii_get_property("bucket")
end

#bucket=(value) ⇒ Object 



304
305
306
307
 
# File 'timestream/cfn_influx_db_instance.rb', line 304

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



274
275
276
 
# File 'timestream/cfn_influx_db_instance.rb', line 274

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



158
159
160
 
# File 'timestream/cfn_influx_db_instance.rb', line 158

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'timestream/cfn_influx_db_instance.rb', line 163

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


696
697
698
699
 
# File 'timestream/cfn_influx_db_instance.rb', line 696

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


168
169
170
 
# File 'timestream/cfn_influx_db_instance.rb', line 168

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


175
176
177
 
# File 'timestream/cfn_influx_db_instance.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


120
121
122
 
# File 'timestream/cfn_influx_db_instance.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#db_instance_type ⇒ String?

The Timestream for InfluxDB DB instance type to run on.

Returns:

  • (String, nil) 


312
313
314
 
# File 'timestream/cfn_influx_db_instance.rb', line 312

def db_instance_type()
  jsii_get_property("dbInstanceType")
end

#db_instance_type=(value) ⇒ Object 



316
317
318
319
 
# File 'timestream/cfn_influx_db_instance.rb', line 316

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

#db_parameter_group_identifier ⇒ String?

The name or id of the DB parameter group to assign to your DB instance.

Returns:

  • (String, nil) 


324
325
326
 
# File 'timestream/cfn_influx_db_instance.rb', line 324

def db_parameter_group_identifier()
  jsii_get_property("dbParameterGroupIdentifier")
end

#db_parameter_group_identifier=(value) ⇒ Object 



328
329
330
331
 
# File 'timestream/cfn_influx_db_instance.rb', line 328

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

#db_storage_type ⇒ String?

The Timestream for InfluxDB DB storage type to read and write InfluxDB data.

Returns:

  • (String, nil) 


336
337
338
 
# File 'timestream/cfn_influx_db_instance.rb', line 336

def db_storage_type()
  jsii_get_property("dbStorageType")
end

#db_storage_type=(value) ⇒ Object 



340
341
342
343
 
# File 'timestream/cfn_influx_db_instance.rb', line 340

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

#deployment_type ⇒ String?

Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.

Returns:

  • (String, nil) 


348
349
350
 
# File 'timestream/cfn_influx_db_instance.rb', line 348

def deployment_type()
  jsii_get_property("deploymentType")
end

#deployment_type=(value) ⇒ Object 



352
353
354
355
 
# File 'timestream/cfn_influx_db_instance.rb', line 352

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



180
181
182
 
# File 'timestream/cfn_influx_db_instance.rb', line 180

def env()
  jsii_get_property("env")
end

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

Returns a token for an runtime attribute of this resource.

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

Parameters:

Returns:



709
710
711
712
713
 
# File 'timestream/cfn_influx_db_instance.rb', line 709

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:



720
721
722
723
 
# File 'timestream/cfn_influx_db_instance.rb', line 720

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

#influx_db_instance_ref ⇒ AWSCDK::Interfaces::AWSTimestream::InfluxDBInstanceReference

A reference to a InfluxDBInstance resource.

Returns:



281
282
283
 
# File 'timestream/cfn_influx_db_instance.rb', line 281

def influx_db_instance_ref()
  jsii_get_property("influxDbInstanceRef")
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



790
791
792
793
 
# File 'timestream/cfn_influx_db_instance.rb', line 790

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

#log_delivery_configuration ⇒ AWSCDK::IResolvable, ...

Configuration for sending InfluxDB engine logs to a specified S3 bucket.

Returns:



360
361
362
 
# File 'timestream/cfn_influx_db_instance.rb', line 360

def log_delivery_configuration()
  jsii_get_property("logDeliveryConfiguration")
end

#log_delivery_configuration=(value) ⇒ Object 



364
365
366
367
368
 
# File 'timestream/cfn_influx_db_instance.rb', line 364

def log_delivery_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Timestream::CfnInfluxDBInstance::LogDeliveryConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190aW1lc3RyZWFtLkNmbkluZmx1eERCSW5zdGFuY2UuTG9nRGVsaXZlcnlDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "logDeliveryConfiguration") unless value.nil?
  jsii_set_property("logDeliveryConfiguration", 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) 


132
133
134
 
# File 'timestream/cfn_influx_db_instance.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance_schedule ⇒ AWSCDK::IResolvable, ...

The maintenance schedule for the InfluxDB instance.

Returns:



373
374
375
 
# File 'timestream/cfn_influx_db_instance.rb', line 373

def maintenance_schedule()
  jsii_get_property("maintenanceSchedule")
end

#maintenance_schedule=(value) ⇒ Object 



377
378
379
380
381
 
# File 'timestream/cfn_influx_db_instance.rb', line 377

def maintenance_schedule=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Timestream::CfnInfluxDBInstance::MaintenanceScheduleProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190aW1lc3RyZWFtLkNmbkluZmx1eERCSW5zdGFuY2UuTWFpbnRlbmFuY2VTY2hlZHVsZVByb3BlcnR5In1dfX0=")), "maintenanceSchedule") unless value.nil?
  jsii_set_property("maintenanceSchedule", value)
end

#name ⇒ String?

The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.

Returns:

  • (String, nil) 


386
387
388
 
# File 'timestream/cfn_influx_db_instance.rb', line 386

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



390
391
392
393
 
# File 'timestream/cfn_influx_db_instance.rb', line 390

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

#network_type ⇒ String?

Network type of the InfluxDB Instance.

Returns:

  • (String, nil) 


398
399
400
 
# File 'timestream/cfn_influx_db_instance.rb', line 398

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



402
403
404
405
 
# File 'timestream/cfn_influx_db_instance.rb', line 402

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) 


115
116
117
 
# File 'timestream/cfn_influx_db_instance.rb', line 115

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:



731
732
733
 
# File 'timestream/cfn_influx_db_instance.rb', line 731

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:



738
739
740
 
# File 'timestream/cfn_influx_db_instance.rb', line 738

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

#organization ⇒ String?

The name of the initial organization for the initial admin user in InfluxDB.

Returns:

  • (String, nil) 


410
411
412
 
# File 'timestream/cfn_influx_db_instance.rb', line 410

def organization()
  jsii_get_property("organization")
end

#organization=(value) ⇒ Object 



414
415
416
417
 
# File 'timestream/cfn_influx_db_instance.rb', line 414

def organization=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "organization") unless value.nil?
  jsii_set_property("organization", value)
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.



531
532
533
534
 
# File 'timestream/cfn_influx_db_instance.rb', line 531

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

#password ⇒ String?

The password of the initial admin user created in InfluxDB.

Returns:

  • (String, nil) 


422
423
424
 
# File 'timestream/cfn_influx_db_instance.rb', line 422

def password()
  jsii_get_property("password")
end

#password=(value) ⇒ Object 



426
427
428
429
 
# File 'timestream/cfn_influx_db_instance.rb', line 426

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

#port ⇒ Numeric?

The port number on which InfluxDB accepts connections.

Returns:

  • (Numeric, nil) 


434
435
436
 
# File 'timestream/cfn_influx_db_instance.rb', line 434

def port()
  jsii_get_property("port")
end

#port=(value) ⇒ Object 



438
439
440
441
 
# File 'timestream/cfn_influx_db_instance.rb', line 438

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

#publicly_accessible ⇒ Boolean, ...

Configures the DB instance with a public IP to facilitate access.

Returns:



446
447
448
 
# File 'timestream/cfn_influx_db_instance.rb', line 446

def publicly_accessible()
  jsii_get_property("publiclyAccessible")
end

#publicly_accessible=(value) ⇒ Object 



450
451
452
453
 
# File 'timestream/cfn_influx_db_instance.rb', line 450

def publicly_accessible=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "publiclyAccessible") unless value.nil?
  jsii_set_property("publiclyAccessible", 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) 


151
152
153
 
# File 'timestream/cfn_influx_db_instance.rb', line 151

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:



749
750
751
752
 
# File 'timestream/cfn_influx_db_instance.rb', line 749

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


756
757
758
759
 
# File 'timestream/cfn_influx_db_instance.rb', line 756

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:



766
767
768
769
770
 
# File 'timestream/cfn_influx_db_instance.rb', line 766

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.

Returns:

  • (Boolean) —

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



775
776
777
 
# File 'timestream/cfn_influx_db_instance.rb', line 775

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



141
142
143
 
# File 'timestream/cfn_influx_db_instance.rb', line 141

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A list of key-value pairs to associate with the DB instance.

Returns:



458
459
460
 
# File 'timestream/cfn_influx_db_instance.rb', line 458

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



462
463
464
465
466
 
# File 'timestream/cfn_influx_db_instance.rb', line 462

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



507
508
509
 
# File 'timestream/cfn_influx_db_instance.rb', line 507

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


188
189
190
 
# File 'timestream/cfn_influx_db_instance.rb', line 188

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


198
199
200
 
# File 'timestream/cfn_influx_db_instance.rb', line 198

def updated_properties()
  jsii_get_property("updatedProperties")
end

#username ⇒ String?

The username of the initial admin user created in InfluxDB.

Returns:

  • (String, nil) 


471
472
473
 
# File 'timestream/cfn_influx_db_instance.rb', line 471

def username()
  jsii_get_property("username")
end

#username=(value) ⇒ Object 



475
476
477
478
 
# File 'timestream/cfn_influx_db_instance.rb', line 475

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


781
782
783
784
 
# File 'timestream/cfn_influx_db_instance.rb', line 781

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

A list of VPC security group IDs to associate with the DB instance.

Returns:

  • (Array<String>, nil) 


483
484
485
 
# File 'timestream/cfn_influx_db_instance.rb', line 483

def vpc_security_group_ids()
  jsii_get_property("vpcSecurityGroupIds")
end

#vpc_security_group_ids=(value) ⇒ Object 



487
488
489
490
 
# File 'timestream/cfn_influx_db_instance.rb', line 487

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

#vpc_subnet_ids ⇒ Array<String>?

A list of VPC subnet IDs to associate with the DB instance.

Returns:

  • (Array<String>, nil) 


495
496
497
 
# File 'timestream/cfn_influx_db_instance.rb', line 495

def vpc_subnet_ids()
  jsii_get_property("vpcSubnetIds")
end

#vpc_subnet_ids=(value) ⇒ Object 



499
500
501
502
 
# File 'timestream/cfn_influx_db_instance.rb', line 499

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

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

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

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


520
521
522
523
524
525
 
# File 'timestream/cfn_influx_db_instance.rb', line 520

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