Package software.amazon.awssdk.services.codepipeline.model

Class EncryptionKey

java.lang.Object

software.amazon.awssdk.services.codepipeline.model.EncryptionKey

All Implemented Interfaces:

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

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

Represents information about the key used to encrypt data in the artifact store, such as an Amazon Web Services Key Management Service (Key Management Service) key.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EncryptionKey.Builder

Method Summary

Modifier and Type	Method	Description
static EncryptionKey.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID used to identify the key.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EncryptionKey.Builder>	serializableBuilderClass()
EncryptionKey.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
EncryptionKeyType	type()	The type of encryption key, such as an Amazon Web Services KMS key.
String	typeAsString()	The type of encryption key, such as an Amazon Web Services KMS key.

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

id

public final String id()

The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.

Aliases are recognized only in the account that created the KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).

Returns:

The ID used to identify the key. For an Amazon Web Services KMS key, you can use the key ID, the key ARN, or the alias ARN.

Aliases are recognized only in the account that created the KMS key. For cross-account actions, you can only use the key ID or key ARN to identify the key. Cross-account actions involve using the role from the other account (AccountB), so specifying the key ID will use the key from the other account (AccountB).

type

public final EncryptionKeyType type()

The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.

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

Returns:

The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.

See Also:

EncryptionKeyType

typeAsString

public final String typeAsString()

The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.

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

Returns:

The type of encryption key, such as an Amazon Web Services KMS key. When creating or updating a pipeline, the value must be set to 'KMS'.

See Also:

EncryptionKeyType

toBuilder

public EncryptionKey.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EncryptionKey.Builder,EncryptionKey>

builder

public static EncryptionKey.Builder builder()

serializableBuilderClass

public static Class<? extends EncryptionKey.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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo