Class: Aws::TimestreamInfluxDB::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb

Overview

An API client for TimestreamInfluxDB. To construct a client, you need to configure a :region and :credentials.

client = Aws::TimestreamInfluxDB::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::TimestreamInfluxDB::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::TimestreamInfluxDB::EndpointParameters

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



419
420
421
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 419

def initialize(*args)
  super
end

Instance Method Details

#create_db_instance(params = {}) ⇒ Types::CreateDbInstanceOutput

Creates a new Timestream for InfluxDB DB instance.

Examples:

Request syntax with placeholder values


resp = client.create_db_instance({
  name: "DbInstanceName", # required
  username: "Username",
  password: "Password", # required
  organization: "Organization",
  bucket: "Bucket",
  db_instance_type: "db.influx.medium", # required, accepts db.influx.medium, db.influx.large, db.influx.xlarge, db.influx.2xlarge, db.influx.4xlarge, db.influx.8xlarge, db.influx.12xlarge, db.influx.16xlarge
  vpc_subnet_ids: ["VpcSubnetId"], # required
  vpc_security_group_ids: ["VpcSecurityGroupId"], # required
  publicly_accessible: false,
  db_storage_type: "InfluxIOIncludedT1", # accepts InfluxIOIncludedT1, InfluxIOIncludedT2, InfluxIOIncludedT3
  allocated_storage: 1, # required
  db_parameter_group_identifier: "DbParameterGroupIdentifier",
  deployment_type: "SINGLE_AZ", # accepts SINGLE_AZ, WITH_MULTIAZ_STANDBY
  log_delivery_configuration: {
    s3_configuration: { # required
      bucket_name: "S3ConfigurationBucketNameString", # required
      enabled: false, # required
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
resp.endpoint #=> String
resp.db_instance_type #=> String, one of "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge"
resp.db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
resp.allocated_storage #=> Integer
resp.deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
resp.vpc_subnet_ids #=> Array
resp.vpc_subnet_ids[0] #=> String
resp.publicly_accessible #=> Boolean
resp.vpc_security_group_ids #=> Array
resp.vpc_security_group_ids[0] #=> String
resp.db_parameter_group_identifier #=> String
resp.availability_zone #=> String
resp.secondary_availability_zone #=> String
resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
resp.influx_auth_parameters_secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. DB instance names must be unique per customer and per region.

  • :username (String) —

    The username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. For example, my-user1. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in Amazon Secrets Manager in your account.

  • :password (required, String) —

    The password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. These attributes will be stored in a Secret created in AWS SecretManager in your account.

  • :organization (String) —

    The name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users.

  • :bucket (String) —

    The name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization.

  • :db_instance_type (required, String) —

    The Timestream for InfluxDB DB instance type to run InfluxDB on.

  • :vpc_subnet_ids (required, Array<String>) —

    A list of VPC subnet IDs to associate with the DB instance. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby.

  • :vpc_security_group_ids (required, Array<String>) —

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

  • :publicly_accessible (Boolean) —

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

  • :db_storage_type (String) —

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

    You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements:

    • Influx IO Included 3000 IOPS

    • Influx IO Included 12000 IOPS

    • Influx IO Included 16000 IOPS

  • :allocated_storage (required, Integer) —

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

  • :db_parameter_group_identifier (String) —

    The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

  • :deployment_type (String) —

    Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability.

  • :log_delivery_configuration (Types::LogDeliveryConfiguration) —

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

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



580
581
582
583
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 580

def create_db_instance(params = {}, options = {})
  req = build_request(:create_db_instance, params)
  req.send_request(options)
end

#create_db_parameter_group(params = {}) ⇒ Types::CreateDbParameterGroupOutput

Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.

Examples:

Request syntax with placeholder values


resp = client.create_db_parameter_group({
  name: "DbParameterGroupName", # required
  description: "CreateDbParameterGroupInputDescriptionString",
  parameters: {
    influx_d_bv_2: {
      flux_log_enabled: false,
      log_level: "debug", # accepts debug, info, error
      no_tasks: false,
      query_concurrency: 1,
      query_queue_size: 1,
      tracing_type: "log", # accepts log, jaeger
      metrics_disabled: false,
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

Response structure


resp.id #=> String
resp.name #=> String
resp.arn #=> String
resp.description #=> String
resp.parameters.influx_d_bv_2.flux_log_enabled #=> Boolean
resp.parameters.influx_d_bv_2.log_level #=> String, one of "debug", "info", "error"
resp.parameters.influx_d_bv_2.no_tasks #=> Boolean
resp.parameters.influx_d_bv_2.query_concurrency #=> Integer
resp.parameters.influx_d_bv_2.query_queue_size #=> Integer
resp.parameters.influx_d_bv_2.tracing_type #=> String, one of "log", "jaeger"
resp.parameters.influx_d_bv_2.metrics_disabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the DB parameter group. The name must be unique per customer and per region.

  • :description (String) —

    A description of the DB parameter group.

  • :parameters (Types::Parameters) —

    A list of the parameters that comprise the DB parameter group.

  • :tags (Hash<String,String>) —

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

Returns:

See Also:



648
649
650
651
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 648

def create_db_parameter_group(params = {}, options = {})
  req = build_request(:create_db_parameter_group, params)
  req.send_request(options)
end

#delete_db_instance(params = {}) ⇒ Types::DeleteDbInstanceOutput

Deletes a Timestream for InfluxDB DB instance.

Examples:

Request syntax with placeholder values


resp = client.delete_db_instance({
  identifier: "DbInstanceIdentifier", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
resp.endpoint #=> String
resp.db_instance_type #=> String, one of "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge"
resp.db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
resp.allocated_storage #=> Integer
resp.deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
resp.vpc_subnet_ids #=> Array
resp.vpc_subnet_ids[0] #=> String
resp.publicly_accessible #=> Boolean
resp.vpc_security_group_ids #=> Array
resp.vpc_security_group_ids[0] #=> String
resp.db_parameter_group_identifier #=> String
resp.availability_zone #=> String
resp.secondary_availability_zone #=> String
resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
resp.influx_auth_parameters_secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the DB instance.

Returns:

See Also:



711
712
713
714
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 711

def delete_db_instance(params = {}, options = {})
  req = build_request(:delete_db_instance, params)
  req.send_request(options)
end

#get_db_instance(params = {}) ⇒ Types::GetDbInstanceOutput

Returns a Timestream for InfluxDB DB instance.

Examples:

Request syntax with placeholder values


resp = client.get_db_instance({
  identifier: "DbInstanceIdentifier", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
resp.endpoint #=> String
resp.db_instance_type #=> String, one of "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge"
resp.db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
resp.allocated_storage #=> Integer
resp.deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
resp.vpc_subnet_ids #=> Array
resp.vpc_subnet_ids[0] #=> String
resp.publicly_accessible #=> Boolean
resp.vpc_security_group_ids #=> Array
resp.vpc_security_group_ids[0] #=> String
resp.db_parameter_group_identifier #=> String
resp.availability_zone #=> String
resp.secondary_availability_zone #=> String
resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
resp.influx_auth_parameters_secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the DB instance.

Returns:

See Also:



774
775
776
777
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 774

def get_db_instance(params = {}, options = {})
  req = build_request(:get_db_instance, params)
  req.send_request(options)
end

#get_db_parameter_group(params = {}) ⇒ Types::GetDbParameterGroupOutput

Returns a Timestream for InfluxDB DB parameter group.

Examples:

Request syntax with placeholder values


resp = client.get_db_parameter_group({
  identifier: "DbParameterGroupIdentifier", # required
})

Response structure


resp.id #=> String
resp.name #=> String
resp.arn #=> String
resp.description #=> String
resp.parameters.influx_d_bv_2.flux_log_enabled #=> Boolean
resp.parameters.influx_d_bv_2.log_level #=> String, one of "debug", "info", "error"
resp.parameters.influx_d_bv_2.no_tasks #=> Boolean
resp.parameters.influx_d_bv_2.query_concurrency #=> Integer
resp.parameters.influx_d_bv_2.query_queue_size #=> Integer
resp.parameters.influx_d_bv_2.tracing_type #=> String, one of "log", "jaeger"
resp.parameters.influx_d_bv_2.metrics_disabled #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the DB parameter group.

Returns:

See Also:



816
817
818
819
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 816

def get_db_parameter_group(params = {}, options = {})
  req = build_request(:get_db_parameter_group, params)
  req.send_request(options)
end

#list_db_instances(params = {}) ⇒ Types::ListDbInstancesOutput

Returns a list of Timestream for InfluxDB DB instances.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_db_instances({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].arn #=> String
resp.items[0].status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
resp.items[0].endpoint #=> String
resp.items[0].db_instance_type #=> String, one of "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge"
resp.items[0].db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
resp.items[0].allocated_storage #=> Integer
resp.items[0].deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • :max_results (Integer) —

    The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Returns:

See Also:



865
866
867
868
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 865

def list_db_instances(params = {}, options = {})
  req = build_request(:list_db_instances, params)
  req.send_request(options)
end

#list_db_parameter_groups(params = {}) ⇒ Types::ListDbParameterGroupsOutput

Returns a list of Timestream for InfluxDB DB parameter groups.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_db_parameter_groups({
  next_token: "NextToken",
  max_results: 1,
})

Response structure


resp.items #=> Array
resp.items[0].id #=> String
resp.items[0].name #=> String
resp.items[0].arn #=> String
resp.items[0].description #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

  • :max_results (Integer) —

    The maximum number of items to return in the output. If the total number of items available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as argument of a subsequent API invocation.

Returns:

See Also:



909
910
911
912
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 909

def list_db_parameter_groups(params = {}, options = {})
  req = build_request(:list_db_parameter_groups, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

A list of tags applied to the resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the tagged resource.

Returns:

See Also:



938
939
940
941
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 938

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the tagged resource.

  • :tags (required, Hash<String,String>) —

    A list of tags used to categorize and track resources.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



967
968
969
970
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 967

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes the tag from the specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the tagged resource.

  • :tag_keys (required, Array<String>) —

    The keys used to identify the tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



993
994
995
996
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 993

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_db_instance(params = {}) ⇒ Types::UpdateDbInstanceOutput

Updates a Timestream for InfluxDB DB instance.

Examples:

Request syntax with placeholder values


resp = client.update_db_instance({
  identifier: "DbInstanceIdentifier", # required
  log_delivery_configuration: {
    s3_configuration: { # required
      bucket_name: "S3ConfigurationBucketNameString", # required
      enabled: false, # required
    },
  },
  db_parameter_group_identifier: "DbParameterGroupIdentifier",
})

Response structure


resp.id #=> String
resp.name #=> String
resp.arn #=> String
resp.status #=> String, one of "CREATING", "AVAILABLE", "DELETING", "MODIFYING", "UPDATING", "DELETED", "FAILED"
resp.endpoint #=> String
resp.db_instance_type #=> String, one of "db.influx.medium", "db.influx.large", "db.influx.xlarge", "db.influx.2xlarge", "db.influx.4xlarge", "db.influx.8xlarge", "db.influx.12xlarge", "db.influx.16xlarge"
resp.db_storage_type #=> String, one of "InfluxIOIncludedT1", "InfluxIOIncludedT2", "InfluxIOIncludedT3"
resp.allocated_storage #=> Integer
resp.deployment_type #=> String, one of "SINGLE_AZ", "WITH_MULTIAZ_STANDBY"
resp.vpc_subnet_ids #=> Array
resp.vpc_subnet_ids[0] #=> String
resp.publicly_accessible #=> Boolean
resp.vpc_security_group_ids #=> Array
resp.vpc_security_group_ids[0] #=> String
resp.db_parameter_group_identifier #=> String
resp.availability_zone #=> String
resp.secondary_availability_zone #=> String
resp.log_delivery_configuration.s3_configuration.bucket_name #=> String
resp.log_delivery_configuration.s3_configuration.enabled #=> Boolean
resp.influx_auth_parameters_secret_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :identifier (required, String) —

    The id of the DB instance.

  • :log_delivery_configuration (Types::LogDeliveryConfiguration) —

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

  • :db_parameter_group_identifier (String) —

    The id of the DB parameter group to assign to your DB instance. DB parameter groups specify how the database is configured. For example, DB parameter groups can specify the limit for query concurrency.

Returns:

See Also:



1072
1073
1074
1075
 
# File 'gems/aws-sdk-timestreaminfluxdb/lib/aws-sdk-timestreaminfluxdb/client.rb', line 1072

def update_db_instance(params = {}, options = {})
  req = build_request(:update_db_instance, params)
  req.send_request(options)
end