Package software.amazon.awssdk.services.neptune.model

Interface CreateDbClusterRequest.Builder

    • Method Detail

      • availabilityZones

        CreateDbClusterRequest.Builder availabilityZones​(Collection<String> availabilityZones)

        A list of EC2 Availability Zones that instances in the DB cluster can be created in.

        Parameters:
        availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • availabilityZones

        CreateDbClusterRequest.Builder availabilityZones​(String... availabilityZones)

        A list of EC2 Availability Zones that instances in the DB cluster can be created in.

        Parameters:
        availabilityZones - A list of EC2 Availability Zones that instances in the DB cluster can be created in.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backupRetentionPeriod

        CreateDbClusterRequest.Builder backupRetentionPeriod​(Integer backupRetentionPeriod)

        The number of days for which automated backups are retained. You must specify a minimum value of 1.

        Default: 1

        Constraints:

        • Must be a value from 1 to 35

        Parameters:
        backupRetentionPeriod - The number of days for which automated backups are retained. You must specify a minimum value of 1.

        Default: 1

        Constraints:

        • Must be a value from 1 to 35

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • characterSetName

        CreateDbClusterRequest.Builder characterSetName​(String characterSetName)

        (Not supported by Neptune)

        Parameters:
        characterSetName - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • copyTagsToSnapshot

        CreateDbClusterRequest.Builder copyTagsToSnapshot​(Boolean copyTagsToSnapshot)

        If set to true, tags are copied to any snapshot of the DB cluster that is created.

        Parameters:
        copyTagsToSnapshot - If set to true, tags are copied to any snapshot of the DB cluster that is created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • databaseName

        CreateDbClusterRequest.Builder databaseName​(String databaseName)

        The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

        Parameters:
        databaseName - The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterIdentifier

        CreateDbClusterRequest.Builder dbClusterIdentifier​(String dbClusterIdentifier)

        The DB cluster identifier. This parameter is stored as a lowercase string.

        Constraints:

        • Must contain from 1 to 63 letters, numbers, or hyphens.

        • First character must be a letter.

        • Cannot end with a hyphen or contain two consecutive hyphens.

        Example: my-cluster1

        Parameters:
        dbClusterIdentifier - The DB cluster identifier. This parameter is stored as a lowercase string.

        Constraints:

        • Must contain from 1 to 63 letters, numbers, or hyphens.

        • First character must be a letter.

        • Cannot end with a hyphen or contain two consecutive hyphens.

        Example: my-cluster1

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbClusterParameterGroupName

        CreateDbClusterRequest.Builder dbClusterParameterGroupName​(String dbClusterParameterGroupName)

        The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

        Constraints:

        • If supplied, must match the name of an existing DBClusterParameterGroup.

        Parameters:
        dbClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

        Constraints:

        • If supplied, must match the name of an existing DBClusterParameterGroup.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        CreateDbClusterRequest.Builder vpcSecurityGroupIds​(Collection<String> vpcSecurityGroupIds)

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

        Parameters:
        vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcSecurityGroupIds

        CreateDbClusterRequest.Builder vpcSecurityGroupIds​(String... vpcSecurityGroupIds)

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

        Parameters:
        vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • dbSubnetGroupName

        CreateDbClusterRequest.Builder dbSubnetGroupName​(String dbSubnetGroupName)

        A DB subnet group to associate with this DB cluster.

        Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

        Example: mySubnetgroup

        Parameters:
        dbSubnetGroupName - A DB subnet group to associate with this DB cluster.

        Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

        Example: mySubnetgroup

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engine

        CreateDbClusterRequest.Builder engine​(String engine)

        The name of the database engine to be used for this DB cluster.

        Valid Values: neptune

        Parameters:
        engine - The name of the database engine to be used for this DB cluster.

        Valid Values: neptune

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • engineVersion

        CreateDbClusterRequest.Builder engineVersion​(String engineVersion)

        The version number of the database engine to use for the new DB cluster.

        Example: 1.0.2.1

        Parameters:
        engineVersion - The version number of the database engine to use for the new DB cluster.

        Example: 1.0.2.1

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • port

        CreateDbClusterRequest.Builder port​(Integer port)

        The port number on which the instances in the DB cluster accept connections.

        Default: 8182

        Parameters:
        port - The port number on which the instances in the DB cluster accept connections.

        Default: 8182

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUsername

        CreateDbClusterRequest.Builder masterUsername​(String masterUsername)

        Not supported by Neptune.

        Parameters:
        masterUsername - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • masterUserPassword

        CreateDbClusterRequest.Builder masterUserPassword​(String masterUserPassword)

        Not supported by Neptune.

        Parameters:
        masterUserPassword - Not supported by Neptune.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optionGroupName

        CreateDbClusterRequest.Builder optionGroupName​(String optionGroupName)

        (Not supported by Neptune)

        Parameters:
        optionGroupName - (Not supported by Neptune)
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredBackupWindow

        CreateDbClusterRequest.Builder preferredBackupWindow​(String preferredBackupWindow)

        The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

        Constraints:

        • Must be in the format hh24:mi-hh24:mi.

        • Must be in Universal Coordinated Time (UTC).

        • Must not conflict with the preferred maintenance window.

        • Must be at least 30 minutes.

        Parameters:
        preferredBackupWindow - The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

        Constraints:

        • Must be in the format hh24:mi-hh24:mi.

        • Must be in Universal Coordinated Time (UTC).

        • Must not conflict with the preferred maintenance window.

        • Must be at least 30 minutes.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preferredMaintenanceWindow

        CreateDbClusterRequest.Builder preferredMaintenanceWindow​(String preferredMaintenanceWindow)

        The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Format: ddd:hh24:mi-ddd:hh24:mi

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

        Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

        Constraints: Minimum 30-minute window.

        Parameters:
        preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

        Format: ddd:hh24:mi-ddd:hh24:mi

        The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

        Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

        Constraints: Minimum 30-minute window.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • replicationSourceIdentifier

        CreateDbClusterRequest.Builder replicationSourceIdentifier​(String replicationSourceIdentifier)

        The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

        Parameters:
        replicationSourceIdentifier - The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDbClusterRequest.Builder tags​(Collection<Tag> tags)

        The tags to assign to the new DB cluster.

        Parameters:
        tags - The tags to assign to the new DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDbClusterRequest.Builder tags​(Tag... tags)

        The tags to assign to the new DB cluster.

        Parameters:
        tags - The tags to assign to the new DB cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDbClusterRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        The tags to assign to the new DB cluster.

        This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

        Parameters:
        tags - a consumer that will call methods on Tag.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tags(java.util.Collection)

      • storageEncrypted

        CreateDbClusterRequest.Builder storageEncrypted​(Boolean storageEncrypted)

        Specifies whether the DB cluster is encrypted.

        Parameters:
        storageEncrypted - Specifies whether the DB cluster is encrypted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        CreateDbClusterRequest.Builder kmsKeyId​(String kmsKeyId)

        The Amazon KMS key identifier for an encrypted DB cluster.

        The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

        If an encryption key is not specified in KmsKeyId:

        • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.

        • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

        Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

        If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

        Parameters:
        kmsKeyId - The Amazon KMS key identifier for an encrypted DB cluster.

        The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

        If an encryption key is not specified in KmsKeyId:

        • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.

        • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

        Amazon KMS creates the default encryption key for your Amazon account. Your Amazon account has a different default encryption key for each Amazon Region.

        If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preSignedUrl

        CreateDbClusterRequest.Builder preSignedUrl​(String preSignedUrl)

        This parameter is not currently supported.

        Parameters:
        preSignedUrl - This parameter is not currently supported.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableIAMDatabaseAuthentication

        CreateDbClusterRequest.Builder enableIAMDatabaseAuthentication​(Boolean enableIAMDatabaseAuthentication)

        If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

        Default: false.

        Parameters:
        enableIAMDatabaseAuthentication - If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

        Default: false.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableCloudwatchLogsExports

        CreateDbClusterRequest.Builder enableCloudwatchLogsExports​(Collection<String> enableCloudwatchLogsExports)

        A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

        Parameters:
        enableCloudwatchLogsExports - A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableCloudwatchLogsExports

        CreateDbClusterRequest.Builder enableCloudwatchLogsExports​(String... enableCloudwatchLogsExports)

        A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

        Parameters:
        enableCloudwatchLogsExports - A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionProtection

        CreateDbClusterRequest.Builder deletionProtection​(Boolean deletionProtection)

        A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.

        Parameters:
        deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serverlessV2ScalingConfiguration

        CreateDbClusterRequest.Builder serverlessV2ScalingConfiguration​(ServerlessV2ScalingConfiguration serverlessV2ScalingConfiguration)

        Contains the scaling configuration of a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

        Parameters:
        serverlessV2ScalingConfiguration - Contains the scaling configuration of a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • globalClusterIdentifier

        CreateDbClusterRequest.Builder globalClusterIdentifier​(String globalClusterIdentifier)

        The ID of the Neptune global database to which this new DB cluster should be added.

        Parameters:
        globalClusterIdentifier - The ID of the Neptune global database to which this new DB cluster should be added.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • storageType

        CreateDbClusterRequest.Builder storageType​(String storageType)

        The storage type to associate with the DB cluster.

        Valid Values:

        • standard | iopt1

        Default:

        • standard

        When you create a Neptune cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

        Parameters:
        storageType - The storage type to associate with the DB cluster.

        Valid Values:

        • standard | iopt1

        Default:

        • standard

        When you create a Neptune cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn't returned when you set it to standard.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceRegion

        CreateDbClusterRequest.Builder sourceRegion​(String sourceRegion)
        If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.
        Parameters:
        sourceRegion - If PreSignedUrl is not specified, this is the region where the source snapshot is located. A PreSignedUrl will be generated automatically by the SDK.
        Returns:
        Returns a reference to this object so that method calls can be chained together.