Package com.pulumi.aws.timestreaminfluxdb.inputs

Class DbClusterState

  • public final class DbClusterState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DbClusterState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> allocatedStorage()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucket()  
      static DbClusterState.Builder builder()  
      static DbClusterState.Builder builder​(DbClusterState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbInstanceType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbParameterGroupIdentifier()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbStorageType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> deploymentType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> failoverMode()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> influxAuthParametersSecretArn()  
      java.util.Optional<com.pulumi.core.Output<DbClusterLogDeliveryConfigurationArgs>> logDeliveryConfiguration()  
      java.util.Optional<com.pulumi.core.Output<DbClusterMaintenanceScheduleArgs>> maintenanceSchedule()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> organization()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> password()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> readerEndpoint()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<DbClusterTimeoutsArgs>> timeouts()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> username()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSecurityGroupIds()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSubnetIds()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • allocatedStorage

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> allocatedStorage()
        Returns:
        Amount of storage in GiB (gibibytes). The minimum value is `20`, the maximum value is `16384`. The argument `dbStorageType` places restrictions on this argument's minimum value. The following is a list of `dbStorageType` values and the corresponding minimum value for `allocatedStorage`: ` "InfluxIOIncludedT1": `20` , `"InfluxIOIncludedT2" and ` "InfluxIOIncludedT3": `400`. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the Timestream for InfluxDB cluster.

      • bucket

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucket()
        Returns:
        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. Along with `organization`, `username`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).

      • dbInstanceType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbInstanceType()
        Returns:
        Timestream for InfluxDB DB instance type to run InfluxDB on. Valid options are: `"db.influx.medium"`, `"db.influx.large"`, `"db.influx.xlarge"`, `"db.influx.2xlarge"`, `"db.influx.4xlarge"`, `"db.influx.8xlarge"`, `"db.influx.12xlarge"`, and `"db.influx.16xlarge"`. This argument is updatable.

      • dbParameterGroupIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbParameterGroupIdentifier()
        Returns:
        ID of the DB parameter group assigned to your cluster. This argument is updatable. If added to an existing Timestream for InfluxDB cluster or given a new value, will cause an in-place update to the cluster. However, if a cluster already has a value for `dbParameterGroupIdentifier`, removing `dbParameterGroupIdentifier` will cause the cluster to be destroyed and recreated.

      • dbStorageType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> dbStorageType()
        Returns:
        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. Valid options are: `"InfluxIOIncludedT1"`, `"InfluxIOIncludedT2"`, and `"InfluxIOIncludedT3"`. If you use ` "InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for `allocatedStorage` is 400.

      • deploymentType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> deploymentType()
        Returns:
        Type of cluster to create. Valid options are: `"MULTI_NODE_READ_REPLICAS"`. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).

      • endpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endpoint()
        Returns:
        Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086.

      • engineType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineType()
        Returns:
        Database engine type of the DB cluster.

      • failoverMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> failoverMode()
        Returns:
        Behavior of failure recovery when the primary node of the cluster fails. Valid options are: `"AUTOMATIC"` and `"NO_FAILOVER"`.

      • influxAuthParametersSecretArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> influxAuthParametersSecretArn()
        Returns:
        ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. For InfluxDB V2 clusters, the secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. For InfluxDB V3 clusters, the secret contains the InfluxDB admin token.

      • logDeliveryConfiguration

        public java.util.Optional<com.pulumi.core.Output<DbClusterLogDeliveryConfigurationArgs>> logDeliveryConfiguration()
        Returns:
        Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable.

      • maintenanceSchedule

        public java.util.Optional<com.pulumi.core.Output<DbClusterMaintenanceScheduleArgs>> maintenanceSchedule()
        Returns:
        Maintenance schedule for the DB cluster, including the preferred maintenance window and timezone. This argument is updatable. This field is only supported for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. Cluster names must be unique per customer and per region. The argument must start with a letter, cannot contain consecutive hyphens (`-`) and cannot end with a hyphen.

      • networkType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> networkType()
        Returns:
        Network type of the Timestream for InfluxDB cluster. `IPV4` can communicate over IPv4 protocol only, and `DUAL` can communicate over both IPv4 and IPv6 protocols.

      • organization

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> organization()
        Returns:
        Name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along with `bucket`, `username`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).

      • password

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> password()
        Returns:
        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. Along with `bucket`, `username`, and `organization`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group) as the AWS API rejects it.

      • port

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> port()
        Returns:
        Port on which the cluster accepts connections. Valid values: `1024`-`65535`. Cannot be `2375`-`2376`, `7788`-`7799`, `8090`, or `51678`-`51680`. This argument is updatable.

      • publiclyAccessible

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()
        Returns:
        Whether to configure the DB cluster with a public IP to facilitate access. Other resources, such as a VPC, a subnet, an internet gateway, and a route table with routes, are also required to enable public access, in addition to this argument. See "Usage with Public Internet Access Enabled" for an example configuration with all required resources for public internet access.

      • readerEndpoint

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> readerEndpoint()
        Returns:
        Endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • username

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> username()
        Returns:
        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. 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. Along with `bucket`, `organization`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. This field is forbidden for InfluxDB V3 clusters (when using an InfluxDB V3 DB parameter group).

      • vpcSecurityGroupIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSecurityGroupIds()
        Returns:
        List of VPC security group IDs to associate with the cluster.

      • vpcSubnetIds

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> vpcSubnetIds()
        Returns:
        List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby. The following arguments are optional: