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

Class Cluster

    • Method Detail

      • backupPolicyAsString

        public final String backupPolicyAsString()

        The cluster's backup policy.

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

        Returns:
        The cluster's backup policy.
        See Also:
        BackupPolicy

      • backupRetentionPolicy

        public final BackupRetentionPolicy backupRetentionPolicy()

        A policy that defines how the service retains backups.

        Returns:
        A policy that defines how the service retains backups.

      • clusterId

        public final String clusterId()

        The cluster's identifier (ID).

        Returns:
        The cluster's identifier (ID).

      • createTimestamp

        public final Instant createTimestamp()

        The date and time when the cluster was created.

        Returns:
        The date and time when the cluster was created.

      • hasHsms

        public final boolean hasHsms()
        For responses, this returns true if the service returned a value for the Hsms 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.

      • hsms

        public final List<Hsm> hsms()

        Contains information about the HSMs in the cluster.

        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 hasHsms() method.

        Returns:
        Contains information about the HSMs in the cluster.

      • hsmType

        public final String hsmType()

        The type of HSM that the cluster contains.

        Returns:
        The type of HSM that the cluster contains.

      • preCoPassword

        public final String preCoPassword()

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

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

      • securityGroup

        public final String securityGroup()

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

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

      • sourceBackupId

        public final 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.

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

      • stateAsString

        public final String stateAsString()

        The cluster's state.

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

        Returns:
        The cluster's state.
        See Also:
        ClusterState

      • stateMessage

        public final String stateMessage()

        A description of the cluster's state.

        Returns:
        A description of the cluster's state.

      • hasSubnetMapping

        public final boolean hasSubnetMapping()
        For responses, this returns true if the service returned a value for the SubnetMapping 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.

      • subnetMapping

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

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

        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 hasSubnetMapping() method.

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

      • vpcId

        public final String vpcId()

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

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

      • networkType

        public final NetworkType networkType()

        The cluster's NetworkType can be set to either IPV4 (which is the default) or DUALSTACK. When set to IPV4, communication between your application and the Hardware Security Modules (HSMs) is restricted to the IPv4 protocol only. In contrast, the DUALSTACK network type enables communication over both the IPv4 and IPv6 protocols. To use the DUALSTACK option, you'll need to configure your Virtual Private Cloud (VPC) and subnets to support both IPv4 and IPv6. This involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The choice between IPV4 and DUALSTACK network types determines the flexibility of the network addressing setup for your cluster. The DUALSTACK option provides more flexibility by allowing both IPv4 and IPv6 communication.

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

        Returns:
        The cluster's NetworkType can be set to either IPV4 (which is the default) or DUALSTACK. When set to IPV4, communication between your application and the Hardware Security Modules (HSMs) is restricted to the IPv4 protocol only. In contrast, the DUALSTACK network type enables communication over both the IPv4 and IPv6 protocols. To use the DUALSTACK option, you'll need to configure your Virtual Private Cloud (VPC) and subnets to support both IPv4 and IPv6. This involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The choice between IPV4 and DUALSTACK network types determines the flexibility of the network addressing setup for your cluster. The DUALSTACK option provides more flexibility by allowing both IPv4 and IPv6 communication.
        See Also:
        NetworkType

      • networkTypeAsString

        public final String networkTypeAsString()

        The cluster's NetworkType can be set to either IPV4 (which is the default) or DUALSTACK. When set to IPV4, communication between your application and the Hardware Security Modules (HSMs) is restricted to the IPv4 protocol only. In contrast, the DUALSTACK network type enables communication over both the IPv4 and IPv6 protocols. To use the DUALSTACK option, you'll need to configure your Virtual Private Cloud (VPC) and subnets to support both IPv4 and IPv6. This involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The choice between IPV4 and DUALSTACK network types determines the flexibility of the network addressing setup for your cluster. The DUALSTACK option provides more flexibility by allowing both IPv4 and IPv6 communication.

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

        Returns:
        The cluster's NetworkType can be set to either IPV4 (which is the default) or DUALSTACK. When set to IPV4, communication between your application and the Hardware Security Modules (HSMs) is restricted to the IPv4 protocol only. In contrast, the DUALSTACK network type enables communication over both the IPv4 and IPv6 protocols. To use the DUALSTACK option, you'll need to configure your Virtual Private Cloud (VPC) and subnets to support both IPv4 and IPv6. This involves adding IPv6 Classless Inter-Domain Routing (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The choice between IPV4 and DUALSTACK network types determines the flexibility of the network addressing setup for your cluster. The DUALSTACK option provides more flexibility by allowing both IPv4 and IPv6 communication.
        See Also:
        NetworkType

      • certificates

        public final Certificates certificates()

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

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

      • hasTagList

        public final boolean hasTagList()
        For responses, this returns true if the service returned a value for the TagList 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.

      • tagList

        public final List<Tag> tagList()

        The list of tags for the cluster.

        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 hasTagList() method.

        Returns:
        The list of tags for the cluster.

      • modeAsString

        public final String modeAsString()

        The mode of the cluster.

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

        Returns:
        The mode of the cluster.
        See Also:
        ClusterMode

      • serializableBuilderClass

        public static Class<? extends Cluster.Builder> serializableBuilderClass()

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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

      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)