com.amazonaws.services.eventbridge.model.CreateEventBusRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-eventbridge Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.eventbridge.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateEventBusRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* 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.
*
*/
private String name;
/**
*
* If you are creating a partner event bus, this specifies the partner event source that the new event bus will be
* matched with.
*
*/
private String eventSourceName;
/**
*
* The event bus description.
*
*/
private String description;
/**
*
* 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.
*
*
*/
private String kmsKeyIdentifier;
private DeadLetterConfig deadLetterConfig;
/**
*
* Tags to associate with the event bus.
*
*/
private java.util.List tags;
/**
*
* 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.
*
*
* @param 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.
*/
public void setName(String name) {
this.name = 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.
*
*
* @return 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.
*/
public String getName() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventBusRequest withName(String name) {
setName(name);
return this;
}
/**
*
* If you are creating a partner event bus, this specifies the partner event source that the new event bus will be
* matched with.
*
*
* @param eventSourceName
* If you are creating a partner event bus, this specifies the partner event source that the new event bus
* will be matched with.
*/
public void setEventSourceName(String eventSourceName) {
this.eventSourceName = eventSourceName;
}
/**
*
* If you are creating a partner event bus, this specifies the partner event source that the new event bus will be
* matched with.
*
*
* @return If you are creating a partner event bus, this specifies the partner event source that the new event bus
* will be matched with.
*/
public String getEventSourceName() {
return this.eventSourceName;
}
/**
*
* If you are creating a partner event bus, this specifies the partner event source that the new event bus will be
* matched with.
*
*
* @param eventSourceName
* If you are creating a partner event bus, this specifies the partner event source that the new event bus
* will be matched with.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventBusRequest withEventSourceName(String eventSourceName) {
setEventSourceName(eventSourceName);
return this;
}
/**
*
* The event bus description.
*
*
* @param description
* The event bus description.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The event bus description.
*
*
* @return The event bus description.
*/
public String getDescription() {
return this.description;
}
/**
*
* The event bus description.
*
*
* @param description
* The event bus description.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventBusRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setKmsKeyIdentifier(String kmsKeyIdentifier) {
this.kmsKeyIdentifier = 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.
*
*
*
* @return 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.
*
*/
public String getKmsKeyIdentifier() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventBusRequest withKmsKeyIdentifier(String kmsKeyIdentifier) {
setKmsKeyIdentifier(kmsKeyIdentifier);
return this;
}
/**
* @param deadLetterConfig
*/
public void setDeadLetterConfig(DeadLetterConfig deadLetterConfig) {
this.deadLetterConfig = deadLetterConfig;
}
/**
* @return
*/
public DeadLetterConfig getDeadLetterConfig() {
return this.deadLetterConfig;
}
/**
* @param deadLetterConfig
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventBusRequest withDeadLetterConfig(DeadLetterConfig deadLetterConfig) {
setDeadLetterConfig(deadLetterConfig);
return this;
}
/**
*
* Tags to associate with the event bus.
*
*
* @return Tags to associate with the event bus.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* Tags to associate with the event bus.
*
*
* @param tags
* Tags to associate with the event bus.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* Tags to associate with the event bus.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Tags to associate with the event bus.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventBusRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Tags to associate with the event bus.
*
*
* @param tags
* Tags to associate with the event bus.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateEventBusRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getEventSourceName() != null)
sb.append("EventSourceName: ").append(getEventSourceName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getKmsKeyIdentifier() != null)
sb.append("KmsKeyIdentifier: ").append(getKmsKeyIdentifier()).append(",");
if (getDeadLetterConfig() != null)
sb.append("DeadLetterConfig: ").append(getDeadLetterConfig()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateEventBusRequest == false)
return false;
CreateEventBusRequest other = (CreateEventBusRequest) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getEventSourceName() == null ^ this.getEventSourceName() == null)
return false;
if (other.getEventSourceName() != null && other.getEventSourceName().equals(this.getEventSourceName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getKmsKeyIdentifier() == null ^ this.getKmsKeyIdentifier() == null)
return false;
if (other.getKmsKeyIdentifier() != null && other.getKmsKeyIdentifier().equals(this.getKmsKeyIdentifier()) == false)
return false;
if (other.getDeadLetterConfig() == null ^ this.getDeadLetterConfig() == null)
return false;
if (other.getDeadLetterConfig() != null && other.getDeadLetterConfig().equals(this.getDeadLetterConfig()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getEventSourceName() == null) ? 0 : getEventSourceName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getKmsKeyIdentifier() == null) ? 0 : getKmsKeyIdentifier().hashCode());
hashCode = prime * hashCode + ((getDeadLetterConfig() == null) ? 0 : getDeadLetterConfig().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public CreateEventBusRequest clone() {
return (CreateEventBusRequest) super.clone();
}
}