Class UpdateEventBusRequest
- 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.UpdateEventBusRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateEventBusRequest.Builder,UpdateEventBusRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateEventBusRequest extends EventBridgeRequest implements ToCopyableBuilder<UpdateEventBusRequest.Builder,UpdateEventBusRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateEventBusRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateEventBusRequest.Builderbuilder()DeadLetterConfigdeadLetterConfig()Returns the value of the DeadLetterConfig property for this object.Stringdescription()The event bus description.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringkmsKeyIdentifier()The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus.Stringname()The name of the event bus.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends UpdateEventBusRequest.Builder>serializableBuilderClass()UpdateEventBusRequest.BuildertoBuilder()StringtoString()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
-
name
public final String name()
The name of the event bus.
- Returns:
- The name of the event bus.
-
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 events on this event bus. 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 events on the event bus.
For more information, see Managing keys in the Key Management Service Developer Guide.
Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:
-
You call
CreateArchiveon an event bus set to use a customer managed key for encryption. -
You call
CreateDiscovereron an event bus set to use a customer managed key for encryption. -
You call
UpdatedEventBusto set a customer managed key on an event bus with an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge 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 events on this event bus. 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 events on the event bus.
For more information, see Managing keys in the Key Management Service Developer Guide.
Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:
-
You call
CreateArchiveon an event bus set to use a customer managed key for encryption. -
You call
CreateDiscovereron an event bus set to use a customer managed key for encryption. -
You call
UpdatedEventBusto set a customer managed key on an event bus with an archives or schema discovery enabled.
To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.
-
-
-
description
public final String description()
The event bus description.
- Returns:
- The event bus description.
-
deadLetterConfig
public final DeadLetterConfig deadLetterConfig()
Returns the value of the DeadLetterConfig property for this object.- Returns:
- The value of the DeadLetterConfig property for this object.
-
toBuilder
public UpdateEventBusRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateEventBusRequest.Builder,UpdateEventBusRequest>- Specified by:
toBuilderin classEventBridgeRequest
-
builder
public static UpdateEventBusRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateEventBusRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-