JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.dax.model

Class CreateClusterRequest

    • Constructor Detail

      • CreateClusterRequest

        public CreateClusterRequest()
    • Method Detail

      • setClusterName

        public void setClusterName(String clusterName)

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

        Constraints:

        • A name must contain from 1 to 20 alphanumeric characters or hyphens.

        • The first character must be a letter.

        • A name cannot end with a hyphen or contain two consecutive hyphens.

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

        Constraints:

        • A name must contain from 1 to 20 alphanumeric characters or hyphens.

        • The first character must be a letter.

        • A name cannot end with a hyphen or contain two consecutive hyphens.

      • getClusterName

        public String getClusterName()

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

        Constraints:

        • A name must contain from 1 to 20 alphanumeric characters or hyphens.

        • The first character must be a letter.

        • A name cannot end with a hyphen or contain two consecutive hyphens.

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

        Constraints:

        • A name must contain from 1 to 20 alphanumeric characters or hyphens.

        • The first character must be a letter.

        • A name cannot end with a hyphen or contain two consecutive hyphens.

      • withClusterName

        public CreateClusterRequest withClusterName(String clusterName)

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

        Constraints:

        • A name must contain from 1 to 20 alphanumeric characters or hyphens.

        • The first character must be a letter.

        • A name cannot end with a hyphen or contain two consecutive hyphens.

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

        Constraints:

        • A name must contain from 1 to 20 alphanumeric characters or hyphens.

        • The first character must be a letter.

        • A name cannot end with a hyphen or contain two consecutive hyphens.

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

        public void setNodeType(String nodeType)

        The compute and memory capacity of the nodes in the cluster.

        Parameters:
        nodeType - The compute and memory capacity of the nodes in the cluster.
      • getNodeType

        public String getNodeType()

        The compute and memory capacity of the nodes in the cluster.

        Returns:
        The compute and memory capacity of the nodes in the cluster.
      • withNodeType

        public CreateClusterRequest withNodeType(String nodeType)

        The compute and memory capacity of the nodes in the cluster.

        Parameters:
        nodeType - The compute and memory capacity of the nodes in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDescription

        public void setDescription(String description)

        A description of the cluster.

        Parameters:
        description - A description of the cluster.
      • getDescription

        public String getDescription()

        A description of the cluster.

        Returns:
        A description of the cluster.
      • withDescription

        public CreateClusterRequest withDescription(String description)

        A description of the cluster.

        Parameters:
        description - A description of the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setReplicationFactor

        public void setReplicationFactor(Integer replicationFactor)

        The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

        AWS recommends that you have at least two read replicas per cluster.

        Parameters:
        replicationFactor - The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

        AWS recommends that you have at least two read replicas per cluster.

      • getReplicationFactor

        public Integer getReplicationFactor()

        The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

        AWS recommends that you have at least two read replicas per cluster.

        Returns:
        The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

        AWS recommends that you have at least two read replicas per cluster.

      • withReplicationFactor

        public CreateClusterRequest withReplicationFactor(Integer replicationFactor)

        The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

        AWS recommends that you have at least two read replicas per cluster.

        Parameters:
        replicationFactor - The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set ReplicationFactor to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). If the AvailabilityZones parameter is provided, its length must equal the ReplicationFactor.

        AWS recommends that you have at least two read replicas per cluster.

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

        public List<String> getAvailabilityZones()

        The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

        Returns:
        The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
      • setAvailabilityZones

        public void setAvailabilityZones(Collection<String> availabilityZones)

        The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

        Parameters:
        availabilityZones - The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
      • withAvailabilityZones

        public CreateClusterRequest withAvailabilityZones(String... availabilityZones)

        The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

        NOTE: This method appends the values to the existing list (if any). Use setAvailabilityZones(java.util.Collection) or withAvailabilityZones(java.util.Collection) if you want to override the existing values.

        Parameters:
        availabilityZones - The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withAvailabilityZones

        public CreateClusterRequest withAvailabilityZones(Collection<String> availabilityZones)

        The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.

        Parameters:
        availabilityZones - The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated. If provided, the length of this list must equal the ReplicationFactor parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSubnetGroupName

        public void setSubnetGroupName(String subnetGroupName)

        The name of the subnet group to be used for the replication group.

        DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

        Parameters:
        subnetGroupName - The name of the subnet group to be used for the replication group.

        DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

      • getSubnetGroupName

        public String getSubnetGroupName()

        The name of the subnet group to be used for the replication group.

        DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

        Returns:
        The name of the subnet group to be used for the replication group.

        DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

      • withSubnetGroupName

        public CreateClusterRequest withSubnetGroupName(String subnetGroupName)

        The name of the subnet group to be used for the replication group.

        DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

        Parameters:
        subnetGroupName - The name of the subnet group to be used for the replication group.

        DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.

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

        public List<String> getSecurityGroupIds()

        A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

        If this parameter is not specified, DAX assigns the default VPC security group to each node.

        Returns:
        A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

        If this parameter is not specified, DAX assigns the default VPC security group to each node.

      • setSecurityGroupIds

        public void setSecurityGroupIds(Collection<String> securityGroupIds)

        A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

        If this parameter is not specified, DAX assigns the default VPC security group to each node.

        Parameters:
        securityGroupIds - A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

        If this parameter is not specified, DAX assigns the default VPC security group to each node.

      • withSecurityGroupIds

        public CreateClusterRequest withSecurityGroupIds(String... securityGroupIds)

        A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

        If this parameter is not specified, DAX assigns the default VPC security group to each node.

        NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

        Parameters:
        securityGroupIds - A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

        If this parameter is not specified, DAX assigns the default VPC security group to each node.

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

        public CreateClusterRequest withSecurityGroupIds(Collection<String> securityGroupIds)

        A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

        If this parameter is not specified, DAX assigns the default VPC security group to each node.

        Parameters:
        securityGroupIds - A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)

        If this parameter is not specified, DAX assigns the default VPC security group to each node.

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

        public void setPreferredMaintenanceWindow(String preferredMaintenanceWindow)

        Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

        • sun

        • mon

        • tue

        • wed

        • thu

        • fri

        • sat

        Example: sun:05:00-sun:09:00

        If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

        Parameters:
        preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

        • sun

        • mon

        • tue

        • wed

        • thu

        • fri

        • sat

        Example: sun:05:00-sun:09:00

        If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

      • getPreferredMaintenanceWindow

        public String getPreferredMaintenanceWindow()

        Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

        • sun

        • mon

        • tue

        • wed

        • thu

        • fri

        • sat

        Example: sun:05:00-sun:09:00

        If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

        Returns:
        Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

        • sun

        • mon

        • tue

        • wed

        • thu

        • fri

        • sat

        Example: sun:05:00-sun:09:00

        If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

      • withPreferredMaintenanceWindow

        public CreateClusterRequest withPreferredMaintenanceWindow(String preferredMaintenanceWindow)

        Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

        • sun

        • mon

        • tue

        • wed

        • thu

        • fri

        • sat

        Example: sun:05:00-sun:09:00

        If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

        Parameters:
        preferredMaintenanceWindow - Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for ddd are:

        • sun

        • mon

        • tue

        • wed

        • thu

        • fri

        • sat

        Example: sun:05:00-sun:09:00

        If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.

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

        public void setNotificationTopicArn(String notificationTopicArn)

        The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the DAX cluster owner.

        Parameters:
        notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the DAX cluster owner.

      • getNotificationTopicArn

        public String getNotificationTopicArn()

        The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the DAX cluster owner.

        Returns:
        The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the DAX cluster owner.

      • withNotificationTopicArn

        public CreateClusterRequest withNotificationTopicArn(String notificationTopicArn)

        The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the DAX cluster owner.

        Parameters:
        notificationTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.

        The Amazon SNS topic owner must be same as the DAX cluster owner.

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

        public void setIamRoleArn(String iamRoleArn)

        A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        Parameters:
        iamRoleArn - A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
      • getIamRoleArn

        public String getIamRoleArn()

        A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        Returns:
        A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
      • withIamRoleArn

        public CreateClusterRequest withIamRoleArn(String iamRoleArn)

        A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

        Parameters:
        iamRoleArn - A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setParameterGroupName

        public void setParameterGroupName(String parameterGroupName)

        The parameter group to be associated with the DAX cluster.

        Parameters:
        parameterGroupName - The parameter group to be associated with the DAX cluster.
      • getParameterGroupName

        public String getParameterGroupName()

        The parameter group to be associated with the DAX cluster.

        Returns:
        The parameter group to be associated with the DAX cluster.
      • withParameterGroupName

        public CreateClusterRequest withParameterGroupName(String parameterGroupName)

        The parameter group to be associated with the DAX cluster.

        Parameters:
        parameterGroupName - The parameter group to be associated with the DAX cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getTags

        public List<Tag> getTags()

        A set of tags to associate with the DAX cluster.

        Returns:
        A set of tags to associate with the DAX cluster.
      • setTags

        public void setTags(Collection<Tag> tags)

        A set of tags to associate with the DAX cluster.

        Parameters:
        tags - A set of tags to associate with the DAX cluster.
      • withTags

        public CreateClusterRequest withTags(Tag... tags)

        A set of tags to associate with the DAX cluster.

        NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

        Parameters:
        tags - A set of tags to associate with the DAX cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withTags

        public CreateClusterRequest withTags(Collection<Tag> tags)

        A set of tags to associate with the DAX cluster.

        Parameters:
        tags - A set of tags to associate with the DAX cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSSESpecification

        public void setSSESpecification(SSESpecification sSESpecification)

        Represents the settings used to enable server-side encryption on the cluster.

        Parameters:
        sSESpecification - Represents the settings used to enable server-side encryption on the cluster.
      • getSSESpecification

        public SSESpecification getSSESpecification()

        Represents the settings used to enable server-side encryption on the cluster.

        Returns:
        Represents the settings used to enable server-side encryption on the cluster.
      • withSSESpecification

        public CreateClusterRequest withSSESpecification(SSESpecification sSESpecification)

        Represents the settings used to enable server-side encryption on the cluster.

        Parameters:
        sSESpecification - Represents the settings used to enable server-side encryption on the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setClusterEndpointEncryptionType

        public void setClusterEndpointEncryptionType(String clusterEndpointEncryptionType)

        The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Parameters:
        clusterEndpointEncryptionType - The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        See Also:
        ClusterEndpointEncryptionType
      • getClusterEndpointEncryptionType

        public String getClusterEndpointEncryptionType()

        The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Returns:
        The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        See Also:
        ClusterEndpointEncryptionType
      • withClusterEndpointEncryptionType

        public CreateClusterRequest withClusterEndpointEncryptionType(String clusterEndpointEncryptionType)

        The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Parameters:
        clusterEndpointEncryptionType - The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterEndpointEncryptionType
      • withClusterEndpointEncryptionType

        public CreateClusterRequest withClusterEndpointEncryptionType(ClusterEndpointEncryptionType clusterEndpointEncryptionType)

        The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Parameters:
        clusterEndpointEncryptionType - The type of encryption the cluster's endpoint should support. Values are:

        • NONE for no encryption

        • TLS for Transport Layer Security

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterEndpointEncryptionType
      • toString

        public 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
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /