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

Class CreateArchiveRequest

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.CreateArchiveRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateArchiveRequest.Builder,CreateArchiveRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateArchiveRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	archiveName()	The name for the archive to create.
static CreateArchiveRequest.Builder	builder()
String	description()	A description for the archive.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventPattern()	An event pattern to use to filter events sent to the archive.
String	eventSourceArn()	The ARN of the event bus that sends events 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 for.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateArchiveRequest.Builder>	serializableBuilderClass()
CreateArchiveRequest.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 for the archive to create.

Returns:

The name for the archive to create.

eventSourceArn

public final String eventSourceArn()

The ARN of the event bus that sends events to the archive.

Returns:

The ARN of the event bus that sends events to the archive.

description

public final String description()

A description for the archive.

Returns:

A description for the archive.

eventPattern

public final String eventPattern()

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

Returns:

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

retentionDays

public final Integer retentionDays()

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

Returns:

The number of days to retain events for. Default value is 0. If set to 0, events are retained indefinitely

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 CreateArchiveRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateArchiveRequest.Builder,CreateArchiveRequest>

Specified by:

toBuilder in class EventBridgeRequest

builder

public static CreateArchiveRequest.Builder builder()

serializableBuilderClass

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