Package software.amazon.awssdk.services.eventbridge.model

Class UpdateArchiveRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest

software.amazon.awssdk.services.eventbridge.model.UpdateArchiveRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateArchiveRequest.Builder,UpdateArchiveRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateArchiveRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	archiveName()	The name of the archive to update.
static UpdateArchiveRequest.Builder	builder()
String	description()	The description for the archive.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventPattern()	The event pattern to use to filter events sent to the archive.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyIdentifier()	The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive.
Integer	retentionDays()	The number of days to retain events in the archive.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateArchiveRequest.Builder>	serializableBuilderClass()
UpdateArchiveRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

archiveName

public final String archiveName()

The name of the archive to update.

Returns:

The name of the archive to update.

description

public final String description()

The description for the archive.

Returns:

The description for the archive.

eventPattern

public final String eventPattern()

The event pattern to use to filter events sent to the archive.

Returns:

The event pattern to use to filter events sent to the archive.

retentionDays

public final Integer retentionDays()

The number of days to retain events in the archive.

Returns:

The number of days to retain events in the archive.

kmsKeyIdentifier

public final String kmsKeyIdentifier()

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.

For more information, see Identify and view keys in the Key Management Service Developer Guide.

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

Returns:

The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.

If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.

For more information, see Identify and view keys in the Key Management Service Developer Guide.

If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.

For more information, see Encrypting archives in the Amazon EventBridge User Guide.

toBuilder

public UpdateArchiveRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateArchiveRequest.Builder,UpdateArchiveRequest>

Specified by:

toBuilder in class EventBridgeRequest

builder

public static UpdateArchiveRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

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