Package software.amazon.awssdk.services.timestreaminfluxdb.model

Class CreateDbInstanceRequest

    • Method Detail

      • name

        public final String name()

        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.

        Returns:
        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

        public final String username()

        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.

        Returns:
        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

        public final String password()

        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.

        Returns:
        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

        public final String organization()

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

        Returns:
        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

        public final String bucket()

        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.

        Returns:
        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.

      • hasVpcSubnetIds

        public final boolean hasVpcSubnetIds()
        For responses, this returns true if the service returned a value for the VpcSubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • vpcSubnetIds

        public final List<String> vpcSubnetIds()

        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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSubnetIds() method.

        Returns:
        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.

      • hasVpcSecurityGroupIds

        public final boolean hasVpcSecurityGroupIds()
        For responses, this returns true if the service returned a value for the VpcSecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • vpcSecurityGroupIds

        public final List<String> vpcSecurityGroupIds()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasVpcSecurityGroupIds() method.

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

      • publiclyAccessible

        public final Boolean publiclyAccessible()

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

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

      • dbStorageType

        public final DbStorageType dbStorageType()

        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

        If the service returns an enum value that is not available in the current SDK version, dbStorageType will return DbStorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dbStorageTypeAsString().

        Returns:
        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

        See Also:
        DbStorageType

      • dbStorageTypeAsString

        public final String dbStorageTypeAsString()

        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

        If the service returns an enum value that is not available in the current SDK version, dbStorageType will return DbStorageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dbStorageTypeAsString().

        Returns:
        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

        See Also:
        DbStorageType

      • allocatedStorage

        public final Integer allocatedStorage()

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

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

      • dbParameterGroupIdentifier

        public final String dbParameterGroupIdentifier()

        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:
        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.

      • deploymentType

        public final DeploymentType deploymentType()

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

        If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

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

      • deploymentTypeAsString

        public final String deploymentTypeAsString()

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

        If the service returns an enum value that is not available in the current SDK version, deploymentType will return DeploymentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentTypeAsString().

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

      • logDeliveryConfiguration

        public final LogDeliveryConfiguration logDeliveryConfiguration()

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

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

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

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

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object