Class CfnInfluxDBInstance

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:34:10.699Z") @Stability(Stable) public class CfnInfluxDBInstance extends CfnResource implements IInspectable, ITaggableV2
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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.timestream.*;
 CfnInfluxDBInstance cfnInfluxDBInstance = CfnInfluxDBInstance.Builder.create(this, "MyCfnInfluxDBInstance")
         .allocatedStorage(123)
         .bucket("bucket")
         .dbInstanceType("dbInstanceType")
         .dbParameterGroupIdentifier("dbParameterGroupIdentifier")
         .dbStorageType("dbStorageType")
         .deploymentType("deploymentType")
         .logDeliveryConfiguration(LogDeliveryConfigurationProperty.builder()
                 .s3Configuration(S3ConfigurationProperty.builder()
                         .bucketName("bucketName")
                         .enabled(false)
                         .build())
                 .build())
         .name("name")
         .organization("organization")
         .password("password")
         .publiclyAccessible(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .username("username")
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .vpcSubnetIds(List.of("vpcSubnetIds"))
         .build();
 

See Also:
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.
  • Constructor Details

    • CfnInfluxDBInstance

      protected CfnInfluxDBInstance(software.amazon.jsii.JsiiObjectRef objRef)
    • CfnInfluxDBInstance

      protected CfnInfluxDBInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
    • CfnInfluxDBInstance

      @Stability(Stable) public CfnInfluxDBInstance(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnInfluxDBInstanceProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.
    • CfnInfluxDBInstance

      @Stability(Stable) public CfnInfluxDBInstance(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the DB instance.
    • getAttrAvailabilityZone

      @Stability(Stable) @NotNull public String getAttrAvailabilityZone()
      The Availability Zone in which the DB instance resides.
    • getAttrEndpoint

      @Stability(Stable) @NotNull public String getAttrEndpoint()
      The endpoint used to connect to InfluxDB.

      The default InfluxDB port is 8086.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      A service-generated unique identifier.
    • getAttrInfluxAuthParametersSecretArn

      @Stability(Stable) @NotNull public String getAttrInfluxAuthParametersSecretArn()
      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.

    • getAttrSecondaryAvailabilityZone

      @Stability(Stable) @NotNull public String getAttrSecondaryAvailabilityZone()
      Describes an Availability Zone in which the InfluxDB instance is located.
    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the DB instance.

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

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getAllocatedStorage

      @Stability(Stable) @Nullable public Number getAllocatedStorage()
      The amount of storage to allocate for your DB storage type in GiB (gibibytes).
    • setAllocatedStorage

      @Stability(Stable) public void setAllocatedStorage(@Nullable Number value)
      The amount of storage to allocate for your DB storage type in GiB (gibibytes).
    • getBucket

      @Stability(Stable) @Nullable public String getBucket()
      The name of the initial InfluxDB bucket.
    • setBucket

      @Stability(Stable) public void setBucket(@Nullable String value)
      The name of the initial InfluxDB bucket.
    • getDbInstanceType

      @Stability(Stable) @Nullable public String getDbInstanceType()
      The Timestream for InfluxDB DB instance type to run on.
    • setDbInstanceType

      @Stability(Stable) public void setDbInstanceType(@Nullable String value)
      The Timestream for InfluxDB DB instance type to run on.
    • getDbParameterGroupIdentifier

      @Stability(Stable) @Nullable public String getDbParameterGroupIdentifier()
      The name or id of the DB parameter group to assign to your DB instance.
    • setDbParameterGroupIdentifier

      @Stability(Stable) public void setDbParameterGroupIdentifier(@Nullable String value)
      The name or id of the DB parameter group to assign to your DB instance.
    • getDbStorageType

      @Stability(Stable) @Nullable public String getDbStorageType()
      The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
    • setDbStorageType

      @Stability(Stable) public void setDbStorageType(@Nullable String value)
      The Timestream for InfluxDB DB storage type to read and write InfluxDB data.
    • getDeploymentType

      @Stability(Stable) @Nullable public String getDeploymentType()
      Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
    • setDeploymentType

      @Stability(Stable) public void setDeploymentType(@Nullable String value)
      Specifies whether the Timestream for InfluxDB is deployed as Single-AZ or with a MultiAZ Standby for High availability.
    • getLogDeliveryConfiguration

      @Stability(Stable) @Nullable public Object getLogDeliveryConfiguration()
      Configuration for sending InfluxDB engine logs to a specified S3 bucket.
    • setLogDeliveryConfiguration

      @Stability(Stable) public void setLogDeliveryConfiguration(@Nullable IResolvable value)
      Configuration for sending InfluxDB engine logs to a specified S3 bucket.
    • setLogDeliveryConfiguration

      @Stability(Stable) public void setLogDeliveryConfiguration(@Nullable CfnInfluxDBInstance.LogDeliveryConfigurationProperty value)
      Configuration for sending InfluxDB engine logs to a specified S3 bucket.
    • getName

      @Stability(Stable) @Nullable public String getName()
      The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name that uniquely identifies the DB instance when interacting with the Amazon Timestream for InfluxDB API and CLI commands.
    • getOrganization

      @Stability(Stable) @Nullable public String getOrganization()
      The name of the initial organization for the initial admin user in InfluxDB.
    • setOrganization

      @Stability(Stable) public void setOrganization(@Nullable String value)
      The name of the initial organization for the initial admin user in InfluxDB.
    • getPassword

      @Stability(Stable) @Nullable public String getPassword()
      The password of the initial admin user created in InfluxDB.
    • setPassword

      @Stability(Stable) public void setPassword(@Nullable String value)
      The password of the initial admin user created in InfluxDB.
    • getPubliclyAccessible

      @Stability(Stable) @Nullable public Object getPubliclyAccessible()
      Configures the DB instance with a public IP to facilitate access.
    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable Boolean value)
      Configures the DB instance with a public IP to facilitate access.
    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable IResolvable value)
      Configures the DB instance with a public IP to facilitate access.
    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of key-value pairs to associate with the DB instance.
    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of key-value pairs to associate with the DB instance.
    • getUsername

      @Stability(Stable) @Nullable public String getUsername()
      The username of the initial admin user created in InfluxDB.
    • setUsername

      @Stability(Stable) public void setUsername(@Nullable String value)
      The username of the initial admin user created in InfluxDB.
    • getVpcSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getVpcSecurityGroupIds()
      A list of VPC security group IDs to associate with the DB instance.
    • setVpcSecurityGroupIds

      @Stability(Stable) public void setVpcSecurityGroupIds(@Nullable List<String> value)
      A list of VPC security group IDs to associate with the DB instance.
    • getVpcSubnetIds

      @Stability(Stable) @Nullable public List<String> getVpcSubnetIds()
      A list of VPC subnet IDs to associate with the DB instance.
    • setVpcSubnetIds

      @Stability(Stable) public void setVpcSubnetIds(@Nullable List<String> value)
      A list of VPC subnet IDs to associate with the DB instance.