com.amazonaws.services.eventbridge.model

Class CreateEventBusRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.eventbridge.model.CreateEventBusRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateEventBusRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateEventBusRequest()

Method Summary

Modifier and Type	Method and Description
CreateEventBusRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
DeadLetterConfig	getDeadLetterConfig()
String	getDescription() The event bus description.
String	getEventSourceName() If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.
String	getKmsKeyIdentifier() 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.
String	getName() The name of the new event bus.
List<Tag>	getTags() Tags to associate with the event bus.
int	hashCode()
void	setDeadLetterConfig(DeadLetterConfig deadLetterConfig)
void	setDescription(String description) The event bus description.
void	setEventSourceName(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.
void	setKmsKeyIdentifier(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.
void	setName(String name) The name of the new event bus.
void	setTags(Collection<Tag> tags) Tags to associate with the event bus.
String	toString() Returns a string representation of this object.
CreateEventBusRequest	withDeadLetterConfig(DeadLetterConfig deadLetterConfig)
CreateEventBusRequest	withDescription(String description) The event bus description.
CreateEventBusRequest	withEventSourceName(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.
CreateEventBusRequest	withKmsKeyIdentifier(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.
CreateEventBusRequest	withName(String name) The name of the new event bus.
CreateEventBusRequest	withTags(Collection<Tag> tags) Tags to associate with the event bus.
CreateEventBusRequest	withTags(Tag... tags) Tags to associate with the event bus.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateEventBusRequest

public CreateEventBusRequest()

Method Detail

setName

public void setName(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 default for a custom event bus, as this name is already used for your account's default event bus.

Parameters:

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 default for a custom event bus, as this name is already used for your account's default event bus.

getName

public String getName()

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 default for 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 default for a custom event bus, as this name is already used for your account's default event bus.

withName

public CreateEventBusRequest withName(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 default for a custom event bus, as this name is already used for your account's default event bus.

Parameters:

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 default for a custom event bus, as this name is already used for your account's default event bus.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEventSourceName

public void setEventSourceName(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.

Parameters:

eventSourceName - If you are creating a partner event bus, this specifies the partner event source that the new event bus will be matched with.

getEventSourceName

public String getEventSourceName()

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.

withEventSourceName

public CreateEventBusRequest withEventSourceName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The event bus description.

Parameters:

description - The event bus description.

getDescription

public String getDescription()

The event bus description.

Returns:

The event bus description.

withDescription

public CreateEventBusRequest withDescription(String description)

The event bus description.

Parameters:

description - The event bus description.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyIdentifier

public void setKmsKeyIdentifier(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 CreateArchive on an event bus set to use a customer managed key for encryption.

• You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

• You call UpdatedEventBus to 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.

Parameters:

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 CreateArchive on an event bus set to use a customer managed key for encryption.

• You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

• You call UpdatedEventBus to 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.

getKmsKeyIdentifier

public String getKmsKeyIdentifier()

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 CreateArchive on an event bus set to use a customer managed key for encryption.

• You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

• You call UpdatedEventBus to 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 CreateArchive on an event bus set to use a customer managed key for encryption.

• You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

• You call UpdatedEventBus to 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.

withKmsKeyIdentifier

public CreateEventBusRequest withKmsKeyIdentifier(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 CreateArchive on an event bus set to use a customer managed key for encryption.

• You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

• You call UpdatedEventBus to 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.

Parameters:

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 CreateArchive on an event bus set to use a customer managed key for encryption.

• You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.

• You call UpdatedEventBus to 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:

Returns a reference to this object so that method calls can be chained together.

setDeadLetterConfig

public void setDeadLetterConfig(DeadLetterConfig deadLetterConfig)

Parameters:

deadLetterConfig -

getDeadLetterConfig

public DeadLetterConfig getDeadLetterConfig()

Returns:

withDeadLetterConfig

public CreateEventBusRequest withDeadLetterConfig(DeadLetterConfig deadLetterConfig)

Parameters:

deadLetterConfig -

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

Tags to associate with the event bus.

Returns:

Tags to associate with the event bus.

setTags

public void setTags(Collection<Tag> tags)

Tags to associate with the event bus.

Parameters:

tags - Tags to associate with the event bus.

withTags

public CreateEventBusRequest withTags(Tag... tags)

Tags to associate with the event bus.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Tags to associate with the event bus.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateEventBusRequest withTags(Collection<Tag> tags)

Tags to associate with the event bus.

Parameters:

tags - Tags to associate with the event bus.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateEventBusRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()