Class: AWSCDK::Timestream::CfnInfluxDBClusterProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
timestream/cfn_influx_db_cluster_props.rb

Overview

Properties for defining a CfnInfluxDBCluster.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allocated_storage: nil, bucket: nil, db_instance_type: nil, db_parameter_group_identifier: nil, db_storage_type: nil, deployment_type: nil, failover_mode: nil, log_delivery_configuration: nil, maintenance_schedule: nil, name: nil, network_type: nil, organization: nil, password: nil, port: nil, publicly_accessible: nil, tags: nil, username: nil, vpc_security_group_ids: nil, vpc_subnet_ids: nil) ⇒ CfnInfluxDBClusterProps

Returns a new instance of CfnInfluxDBClusterProps.

Parameters:

  • allocated_storage (Numeric, nil) (defaults to: nil) —

    The allocated storage for the InfluxDB cluster.

  • bucket (String, nil) (defaults to: nil) —

    The bucket for the InfluxDB cluster.

  • db_instance_type (String, nil) (defaults to: nil) —

    The compute instance of the InfluxDB cluster.

  • db_parameter_group_identifier (String, nil) (defaults to: nil) —

    The name of an existing InfluxDB parameter group.

  • db_storage_type (String, nil) (defaults to: nil) —

    The storage type of the InfluxDB cluster.

  • deployment_type (String, nil) (defaults to: nil) —

    Deployment type of the InfluxDB cluster.

  • failover_mode (String, nil) (defaults to: nil) —

    Failover mode of the InfluxDB cluster.

  • log_delivery_configuration (AWSCDK::IResolvable, AWSCDK::Timestream::CfnInfluxDBCluster::LogDeliveryConfigurationProperty, nil) (defaults to: nil) —

    Configuration for sending logs to customer account from the InfluxDB cluster.

  • maintenance_schedule (AWSCDK::IResolvable, AWSCDK::Timestream::CfnInfluxDBCluster::MaintenanceScheduleProperty, nil) (defaults to: nil) —

    The maintenance schedule for the InfluxDB cluster.

  • name (String, nil) (defaults to: nil) —

    The unique name that is associated with the InfluxDB cluster.

  • network_type (String, nil) (defaults to: nil) —

    Network type of the InfluxDB cluster.

  • organization (String, nil) (defaults to: nil) —

    The organization for the InfluxDB cluster.

  • password (String, nil) (defaults to: nil) —

    The password for the InfluxDB cluster.

  • port (Numeric, nil) (defaults to: nil) —

    The port number on which InfluxDB accepts connections.

  • publicly_accessible (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Attach a public IP to the customer ENI.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An arbitrary set of tags (key-value pairs) for this DB cluster.

  • username (String, nil) (defaults to: nil) —

    The username for the InfluxDB cluster.

  • vpc_security_group_ids (Array<String>, nil) (defaults to: nil) —

    A list of Amazon EC2 VPC security groups to associate with this InfluxDB cluster.

  • vpc_subnet_ids (Array<String>, nil) (defaults to: nil) —

    A list of EC2 subnet IDs for this InfluxDB cluster.



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

def initialize(allocated_storage: nil, bucket: nil, db_instance_type: nil, db_parameter_group_identifier: nil, db_storage_type: nil, deployment_type: nil, failover_mode: nil, log_delivery_configuration: nil, maintenance_schedule: nil, name: nil, network_type: nil, organization: nil, password: nil, port: nil, publicly_accessible: nil, tags: nil, username: nil, vpc_security_group_ids: nil, vpc_subnet_ids: nil)
  @allocated_storage = allocated_storage
  Jsii::Type.check_type(@allocated_storage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "allocatedStorage") unless @allocated_storage.nil?
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucket") unless @bucket.nil?
  @db_instance_type = db_instance_type
  Jsii::Type.check_type(@db_instance_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbInstanceType") unless @db_instance_type.nil?
  @db_parameter_group_identifier = db_parameter_group_identifier
  Jsii::Type.check_type(@db_parameter_group_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbParameterGroupIdentifier") unless @db_parameter_group_identifier.nil?
  @db_storage_type = db_storage_type
  Jsii::Type.check_type(@db_storage_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dbStorageType") unless @db_storage_type.nil?
  @deployment_type = deployment_type
  Jsii::Type.check_type(@deployment_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deploymentType") unless @deployment_type.nil?
  @failover_mode = failover_mode
  Jsii::Type.check_type(@failover_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "failoverMode") unless @failover_mode.nil?
  @log_delivery_configuration = log_delivery_configuration.is_a?(Hash) ? ::AWSCDK::Timestream::CfnInfluxDBCluster::LogDeliveryConfigurationProperty.new(**log_delivery_configuration.transform_keys(&:to_sym)) : log_delivery_configuration
  Jsii::Type.check_type(@log_delivery_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190aW1lc3RyZWFtLkNmbkluZmx1eERCQ2x1c3Rlci5Mb2dEZWxpdmVyeUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "logDeliveryConfiguration") unless @log_delivery_configuration.nil?
  @maintenance_schedule = maintenance_schedule.is_a?(Hash) ? ::AWSCDK::Timestream::CfnInfluxDBCluster::MaintenanceScheduleProperty.new(**maintenance_schedule.transform_keys(&:to_sym)) : maintenance_schedule
  Jsii::Type.check_type(@maintenance_schedule, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c190aW1lc3RyZWFtLkNmbkluZmx1eERCQ2x1c3Rlci5NYWludGVuYW5jZVNjaGVkdWxlUHJvcGVydHkifV19fQ==")), "maintenanceSchedule") unless @maintenance_schedule.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @network_type = network_type
  Jsii::Type.check_type(@network_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkType") unless @network_type.nil?
  @organization = organization
  Jsii::Type.check_type(@organization, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "organization") unless @organization.nil?
  @password = password
  Jsii::Type.check_type(@password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "password") unless @password.nil?
  @port = port
  Jsii::Type.check_type(@port, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "port") unless @port.nil?
  @publicly_accessible = publicly_accessible
  Jsii::Type.check_type(@publicly_accessible, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "publiclyAccessible") unless @publicly_accessible.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @username = username
  Jsii::Type.check_type(@username, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "username") unless @username.nil?
  @vpc_security_group_ids = vpc_security_group_ids
  Jsii::Type.check_type(@vpc_security_group_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "vpcSecurityGroupIds") unless @vpc_security_group_ids.nil?
  @vpc_subnet_ids = vpc_subnet_ids
  Jsii::Type.check_type(@vpc_subnet_ids, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "vpcSubnetIds") unless @vpc_subnet_ids.nil?
end

Instance Attribute Details

#allocated_storage ⇒ Numeric? (readonly)

The allocated storage for the InfluxDB cluster.

Returns:

  • (Numeric, nil)

See Also:



73
74
75
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 73

def allocated_storage
  @allocated_storage
end

#bucket ⇒ String? (readonly)

The bucket for the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



78
79
80
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 78

def bucket
  @bucket
end

#db_instance_type ⇒ String? (readonly)

The compute instance of the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



83
84
85
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 83

def db_instance_type
  @db_instance_type
end

#db_parameter_group_identifier ⇒ String? (readonly)

The name of an existing InfluxDB parameter group.

Returns:

  • (String, nil)

See Also:



88
89
90
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 88

def db_parameter_group_identifier
  @db_parameter_group_identifier
end

#db_storage_type ⇒ String? (readonly)

The storage type of the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



93
94
95
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 93

def db_storage_type
  @db_storage_type
end

#deployment_type ⇒ String? (readonly)

Deployment type of the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



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

def deployment_type
  @deployment_type
end

#failover_mode ⇒ String? (readonly)

Failover mode of the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



103
104
105
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 103

def failover_mode
  @failover_mode
end

#log_delivery_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration for sending logs to customer account from the InfluxDB cluster.

Returns:

See Also:



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

def log_delivery_configuration
  @log_delivery_configuration
end

#maintenance_schedule ⇒ AWSCDK::IResolvable, ... (readonly)

The maintenance schedule for the InfluxDB cluster.

Returns:

See Also:



113
114
115
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 113

def maintenance_schedule
  @maintenance_schedule
end

#name ⇒ String? (readonly)

The unique name that is associated with the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



118
119
120
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 118

def name
  @name
end

#network_type ⇒ String? (readonly)

Network type of the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



123
124
125
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 123

def network_type
  @network_type
end

#organization ⇒ String? (readonly)

The organization for the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



128
129
130
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 128

def organization
  @organization
end

#password ⇒ String? (readonly)

The password for the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



133
134
135
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 133

def password
  @password
end

#port ⇒ Numeric? (readonly)

The port number on which InfluxDB accepts connections.

Returns:

  • (Numeric, nil)

See Also:



138
139
140
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 138

def port
  @port
end

#publicly_accessible ⇒ Boolean, ... (readonly)

Note:

Default: - false

Attach a public IP to the customer ENI.

Returns:

See Also:



144
145
146
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 144

def publicly_accessible
  @publicly_accessible
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An arbitrary set of tags (key-value pairs) for this DB cluster.

Returns:

See Also:



149
150
151
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 149

def tags
  @tags
end

#username ⇒ String? (readonly)

The username for the InfluxDB cluster.

Returns:

  • (String, nil)

See Also:



154
155
156
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 154

def username
  @username
end

#vpc_security_group_ids ⇒ Array<String>? (readonly)

A list of Amazon EC2 VPC security groups to associate with this InfluxDB cluster.

Returns:

  • (Array<String>, nil)

See Also:



159
160
161
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 159

def vpc_security_group_ids
  @vpc_security_group_ids
end

#vpc_subnet_ids ⇒ Array<String>? (readonly)

A list of EC2 subnet IDs for this InfluxDB cluster.

Returns:

  • (Array<String>, nil)

See Also:



164
165
166
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 164

def vpc_subnet_ids
  @vpc_subnet_ids
end

Class Method Details

.jsii_properties ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 166

def self.jsii_properties
  {
    :allocated_storage => "allocatedStorage",
    :bucket => "bucket",
    :db_instance_type => "dbInstanceType",
    :db_parameter_group_identifier => "dbParameterGroupIdentifier",
    :db_storage_type => "dbStorageType",
    :deployment_type => "deploymentType",
    :failover_mode => "failoverMode",
    :log_delivery_configuration => "logDeliveryConfiguration",
    :maintenance_schedule => "maintenanceSchedule",
    :name => "name",
    :network_type => "networkType",
    :organization => "organization",
    :password => "password",
    :port => "port",
    :publicly_accessible => "publiclyAccessible",
    :tags => "tags",
    :username => "username",
    :vpc_security_group_ids => "vpcSecurityGroupIds",
    :vpc_subnet_ids => "vpcSubnetIds",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'timestream/cfn_influx_db_cluster_props.rb', line 190

def to_jsii
  result = {}
  result.merge!({
    "allocatedStorage" => @allocated_storage,
    "bucket" => @bucket,
    "dbInstanceType" => @db_instance_type,
    "dbParameterGroupIdentifier" => @db_parameter_group_identifier,
    "dbStorageType" => @db_storage_type,
    "deploymentType" => @deployment_type,
    "failoverMode" => @failover_mode,
    "logDeliveryConfiguration" => @log_delivery_configuration,
    "maintenanceSchedule" => @maintenance_schedule,
    "name" => @name,
    "networkType" => @network_type,
    "organization" => @organization,
    "password" => @password,
    "port" => @port,
    "publiclyAccessible" => @publicly_accessible,
    "tags" => @tags,
    "username" => @username,
    "vpcSecurityGroupIds" => @vpc_security_group_ids,
    "vpcSubnetIds" => @vpc_subnet_ids,
  })
  result.compact
end