Package software.amazon.awssdk.services.secretsmanager.model

Class CreateSecretResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse

software.amazon.awssdk.services.secretsmanager.model.CreateSecretResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateSecretResponse.Builder,CreateSecretResponse>

@Generated("software.amazon.awssdk:codegen")
public final class CreateSecretResponse
extends SecretsManagerResponse
implements ToCopyableBuilder<CreateSecretResponse.Builder,CreateSecretResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateSecretResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The ARN of the new secret.
static CreateSecretResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReplicationStatus()	For responses, this returns true if the service returned a value for the ReplicationStatus property.
String	name()	The name of the new secret.
List<ReplicationStatusType>	replicationStatus()	A list of the replicas of this secret and their status:
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateSecretResponse.Builder>	serializableBuilderClass()
CreateSecretResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	versionId()	The unique identifier associated with the version of the new secret.

Methods inherited from class software.amazon.awssdk.services.secretsmanager.model.SecretsManagerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

arn

public final String arn()

The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.

Returns:

The ARN of the new secret. The ARN includes the name of the secret followed by six random characters. This ensures that if you create a new secret with the same name as a deleted secret, then users with access to the old secret don't get access to the new secret because the ARNs are different.

name

public final String name()

The name of the new secret.

Returns:

The name of the new secret.

versionId

public final String versionId()

The unique identifier associated with the version of the new secret.

Returns:

The unique identifier associated with the version of the new secret.

hasReplicationStatus

public final boolean hasReplicationStatus()

For responses, this returns true if the service returned a value for the ReplicationStatus 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.

replicationStatus

public final List<ReplicationStatusType> replicationStatus()

A list of the replicas of this secret and their status:

• Failed, which indicates that the replica was not created.

• InProgress, which indicates that Secrets Manager is in the process of creating the replica.

• InSync, which indicates that the replica was created.

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

Returns:

A list of the replicas of this secret and their status:

• Failed, which indicates that the replica was not created.

• InProgress, which indicates that Secrets Manager is in the process of creating the replica.

• InSync, which indicates that the replica was created.

toBuilder

public CreateSecretResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateSecretResponse.Builder,CreateSecretResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static CreateSecretResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo