software.amazon.awssdk.services.managedblockchain.model

Class Member

java.lang.Object

software.amazon.awssdk.services.managedblockchain.model.Member

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Member.Builder,Member>

@Generated(value="software.amazon.awssdk:codegen")
public final class Member
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Member.Builder,Member>

Member configuration properties.

Applies only to Hyperledger Fabric.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Member.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the member.
static Member.Builder	builder()
Instant	creationDate() The date and time that the member was created.
String	description() An optional description for the member.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
MemberFrameworkAttributes	frameworkAttributes() Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	id() The unique identifier of the member.
String	kmsKeyArn() The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the member uses for encryption at rest.
MemberLogPublishingConfiguration	logPublishingConfiguration() Configuration properties for logging events associated with a member.
String	name() The name of the member.
String	networkId() The unique identifier of the network to which the member belongs.
List<SdkField<?>>	sdkFields()
static Class<? extends Member.Builder>	serializableBuilderClass()
MemberStatus	status() The status of a member.
String	statusAsString() The status of a member.
Map<String,String>	tags() Tags assigned to the member.
Member.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

networkId

public final String networkId()

The unique identifier of the network to which the member belongs.

Returns:

The unique identifier of the network to which the member belongs.

id

public final String id()

The unique identifier of the member.

Returns:

The unique identifier of the member.

name

public final String name()

The name of the member.

Returns:

The name of the member.

description

public final String description()

An optional description for the member.

Returns:

An optional description for the member.

frameworkAttributes

public final MemberFrameworkAttributes frameworkAttributes()

Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

Returns:

Attributes relevant to a member for the blockchain framework that the Managed Blockchain network uses.

logPublishingConfiguration

public final MemberLogPublishingConfiguration logPublishingConfiguration()

Configuration properties for logging events associated with a member.

Returns:

Configuration properties for logging events associated with a member.

status

public final MemberStatus status()

The status of a member.

• CREATING - The Amazon Web Services account is in the process of creating a member.

• AVAILABLE - The member has been created and can participate in the network.

• CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed.

• UPDATING - The member is in the process of being updated.

• DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

• DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

• INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.

  The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

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

Returns:

The status of a member.

• CREATING - The Amazon Web Services account is in the process of creating a member.

• AVAILABLE - The member has been created and can participate in the network.

• CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed.

• UPDATING - The member is in the process of being updated.

• DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

• DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

• INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.

  The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

See Also:

MemberStatus

statusAsString

public final String statusAsString()

The status of a member.

• CREATING - The Amazon Web Services account is in the process of creating a member.

• AVAILABLE - The member has been created and can participate in the network.

• CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed.

• UPDATING - The member is in the process of being updated.

• DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

• DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

• INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.

  The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

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

Returns:

The status of a member.

• CREATING - The Amazon Web Services account is in the process of creating a member.

• AVAILABLE - The member has been created and can participate in the network.

• CREATE_FAILED - The Amazon Web Services account attempted to create a member and creation failed.

• UPDATING - The member is in the process of being updated.

• DELETING - The member and all associated resources are in the process of being deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

• DELETED - The member can no longer participate on the network and all associated resources are deleted. Either the Amazon Web Services account that owns the member deleted it, or the member is being deleted as the result of an APPROVED PROPOSAL to remove the member.

• INACCESSIBLE_ENCRYPTION_KEY - The member is impaired and might not function as expected because it cannot access the specified customer managed key in KMS for encryption at rest. Either the KMS key was disabled or deleted, or the grants on the key were revoked.

  The effect of disabling or deleting a key or of revoking a grant isn't immediate. It might take some time for the member resource to discover that the key is inaccessible. When a resource is in this state, we recommend deleting and recreating the resource.

See Also:

MemberStatus

creationDate

public final Instant creationDate()

The date and time that the member was created.

Returns:

The date and time that the member was created.

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()

Tags assigned to the member. Tags consist of a key and optional value.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

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:

Tags assigned to the member. Tags consist of a key and optional value.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

arn

public final String arn()

The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Returns:

The Amazon Resource Name (ARN) of the member. For more information about ARNs and their format, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

kmsKeyArn

public final String kmsKeyArn()

The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the member uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key", the member uses an Amazon Web Services owned KMS key for encryption. This parameter is inherited by the nodes that this member owns.

For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

Returns:

The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) that the member uses for encryption at rest. If the value of this parameter is "AWS Owned KMS Key", the member uses an Amazon Web Services owned KMS key for encryption. This parameter is inherited by the nodes that this member owns.

For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

toBuilder

public Member.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Member.Builder,Member>

builder

public static Member.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo