Package software.amazon.awssdk.services.cloudhsmv2.model

Interface Cluster.Builder

    • Method Detail

      • backupPolicy

        Cluster.Builder backupPolicy​(String backupPolicy)

        The cluster's backup policy.

        Parameters:
        backupPolicy - The cluster's backup policy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BackupPolicy, BackupPolicy

      • backupPolicy

        Cluster.Builder backupPolicy​(BackupPolicy backupPolicy)

        The cluster's backup policy.

        Parameters:
        backupPolicy - The cluster's backup policy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        BackupPolicy, BackupPolicy

      • backupRetentionPolicy

        Cluster.Builder backupRetentionPolicy​(BackupRetentionPolicy backupRetentionPolicy)

        A policy that defines how the service retains backups.

        Parameters:
        backupRetentionPolicy - A policy that defines how the service retains backups.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clusterId

        Cluster.Builder clusterId​(String clusterId)

        The cluster's identifier (ID).

        Parameters:
        clusterId - The cluster's identifier (ID).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createTimestamp

        Cluster.Builder createTimestamp​(Instant createTimestamp)

        The date and time when the cluster was created.

        Parameters:
        createTimestamp - The date and time when the cluster was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hsms

        Cluster.Builder hsms​(Collection<Hsm> hsms)

        Contains information about the HSMs in the cluster.

        Parameters:
        hsms - Contains information about the HSMs in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hsms

        Cluster.Builder hsms​(Hsm... hsms)

        Contains information about the HSMs in the cluster.

        Parameters:
        hsms - Contains information about the HSMs in the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hsms

        Cluster.Builder hsms​(Consumer<Hsm.Builder>... hsms)

        Contains information about the HSMs in the cluster.

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

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

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

      • hsmType

        Cluster.Builder hsmType​(String hsmType)

        The type of HSM that the cluster contains.

        Parameters:
        hsmType - The type of HSM that the cluster contains.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hsmTypeRollbackExpiration

        Cluster.Builder hsmTypeRollbackExpiration​(Instant hsmTypeRollbackExpiration)

        The timestamp until when the cluster can be rolled back to its original HSM type.

        Parameters:
        hsmTypeRollbackExpiration - The timestamp until when the cluster can be rolled back to its original HSM type.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • preCoPassword

        Cluster.Builder preCoPassword​(String preCoPassword)

        The default password for the cluster's Pre-Crypto Officer (PRECO) user.

        Parameters:
        preCoPassword - The default password for the cluster's Pre-Crypto Officer (PRECO) user.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityGroup

        Cluster.Builder securityGroup​(String securityGroup)

        The identifier (ID) of the cluster's security group.

        Parameters:
        securityGroup - The identifier (ID) of the cluster's security group.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceBackupId

        Cluster.Builder sourceBackupId​(String sourceBackupId)

        The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

        Parameters:
        sourceBackupId - The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • state

        Cluster.Builder state​(String state)

        The cluster's state.

        Parameters:
        state - The cluster's state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterState, ClusterState

      • stateMessage

        Cluster.Builder stateMessage​(String stateMessage)

        A description of the cluster's state.

        Parameters:
        stateMessage - A description of the cluster's state.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • subnetMapping

        Cluster.Builder subnetMapping​(Map<String,​String> subnetMapping)

        A map from availability zone to the cluster’s subnet in that availability zone.

        Parameters:
        subnetMapping - A map from availability zone to the cluster’s subnet in that availability zone.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • vpcId

        Cluster.Builder vpcId​(String vpcId)

        The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

        Parameters:
        vpcId - The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • networkType

        Cluster.Builder networkType​(String networkType)

        The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.

        Parameters:
        networkType - The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NetworkType, NetworkType

      • networkType

        Cluster.Builder networkType​(NetworkType networkType)

        The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.

        Parameters:
        networkType - The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 NetworkType restricts communication between your application and the hardware security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, configure your virtual private cloud (VPC) and subnets to support both IPv4 and IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType you choose affects the network addressing options for your cluster. DUALSTACK provides more flexibility by supporting both IPv4 and IPv6 communication.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        NetworkType, NetworkType

      • certificates

        Cluster.Builder certificates​(Certificates certificates)

        Contains one or more certificates or a certificate signing request (CSR).

        Parameters:
        certificates - Contains one or more certificates or a certificate signing request (CSR).
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        Cluster.Builder tagList​(Collection<Tag> tagList)

        The list of tags for the cluster.

        Parameters:
        tagList - The list of tags for the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        Cluster.Builder tagList​(Tag... tagList)

        The list of tags for the cluster.

        Parameters:
        tagList - The list of tags for the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagList

        Cluster.Builder tagList​(Consumer<Tag.Builder>... tagList)

        The list of tags for the 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 #tagList(List).

        Parameters:
        tagList - 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:
        #tagList(java.util.Collection)

      • mode

        Cluster.Builder mode​(String mode)

        The mode of the cluster.

        Parameters:
        mode - The mode of the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterMode, ClusterMode

      • mode

        Cluster.Builder mode​(ClusterMode mode)

        The mode of the cluster.

        Parameters:
        mode - The mode of the cluster.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ClusterMode, ClusterMode