Class CreateEventBusRequest
- 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.CreateEventBusRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateEventBusRequest.Builder,CreateEventBusRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateEventBusRequest extends EventBridgeRequest implements ToCopyableBuilder<CreateEventBusRequest.Builder,CreateEventBusRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateEventBusRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateEventBusRequest.Builderbuilder()DeadLetterConfigdeadLetterConfig()Returns the value of the DeadLetterConfig property for this object.Stringdescription()The event bus description.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventSourceName()If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.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 new event bus.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateEventBusRequest.Builder>serializableBuilderClass()List<Tag>tags()Tags to associate with the event bus.CreateEventBusRequest.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 new event bus.
Custom event bus names can't contain the
/character, but you can use the/character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.You can't use the name
defaultfor a custom event bus, as this name is already used for your account's default event bus.- Returns:
- The name of the new event bus.
Custom event bus names can't contain the
/character, but you can use the/character in partner event bus names. In addition, for partner event buses, the name must exactly match the name of the partner event source that this event bus is matched to.You can't use the name
defaultfor a custom event bus, as this name is already used for your account's default event bus.
-
eventSourceName
public final String eventSourceName()
If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
- Returns:
- If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
-
description
public final String description()
The event bus description.
- Returns:
- The event bus description.
-
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 Identify and view keys in the Key Management Service Developer Guide.
Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if you call
CreateDiscovereron an event bus set to use a customer managed key for encryption.To enable schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Encrypting events in the Amazon EventBridge User 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 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 Identify and view keys in the Key Management Service Developer Guide.
Schema discovery is not supported for event buses encrypted using a customer managed key. EventBridge returns an error if you call
CreateDiscovereron an event bus set to use a customer managed key for encryption.To enable schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Encrypting events in the Amazon EventBridge User 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.
-
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.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
tags
public final List<Tag> tags()
Tags to associate with the event bus.
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
hasTags()method.- Returns:
- Tags to associate with the event bus.
-
toBuilder
public CreateEventBusRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateEventBusRequest.Builder,CreateEventBusRequest>- Specified by:
toBuilderin classEventBridgeRequest
-
builder
public static CreateEventBusRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateEventBusRequest.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
-
-