Class CreateEventSubscriptionRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.redshift.model.CreateEventSubscriptionRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable
public class CreateEventSubscriptionRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

See Also:

  • Constructor Details

    • CreateEventSubscriptionRequest

      public CreateEventSubscriptionRequest()

  • Method Details

    • setSubscriptionName

      public void setSubscriptionName(String subscriptionName)

      The name of the event subscription to be created.

      Constraints:

      • Cannot be null, empty, or blank.
      • Must contain from 1 to 255 alphanumeric characters or hyphens.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.
      Parameters:
      subscriptionName - The name of the event subscription to be created.

      Constraints:

      • Cannot be null, empty, or blank.
      • Must contain from 1 to 255 alphanumeric characters or hyphens.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.

    • getSubscriptionName

      public String getSubscriptionName()

      The name of the event subscription to be created.

      Constraints:

      • Cannot be null, empty, or blank.
      • Must contain from 1 to 255 alphanumeric characters or hyphens.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.
      Returns:
      The name of the event subscription to be created.

      Constraints:

      • Cannot be null, empty, or blank.
      • Must contain from 1 to 255 alphanumeric characters or hyphens.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.

    • withSubscriptionName

      public CreateEventSubscriptionRequest withSubscriptionName(String subscriptionName)

      The name of the event subscription to be created.

      Constraints:

      • Cannot be null, empty, or blank.
      • Must contain from 1 to 255 alphanumeric characters or hyphens.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.
      Parameters:
      subscriptionName - The name of the event subscription to be created.

      Constraints:

      • Cannot be null, empty, or blank.
      • Must contain from 1 to 255 alphanumeric characters or hyphens.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setSnsTopicArn

      public void setSnsTopicArn(String snsTopicArn)

      The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

      Parameters:
      snsTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • getSnsTopicArn

      public String getSnsTopicArn()

      The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • withSnsTopicArn

      public CreateEventSubscriptionRequest withSnsTopicArn(String snsTopicArn)

      The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

      Parameters:
      snsTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • setSourceType

      public void setSourceType(String sourceType)

      The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

      Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

      Parameters:
      sourceType - The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

      Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

    • getSourceType

      public String getSourceType()

      The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

      Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

      Returns:
      The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

      Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

    • withSourceType

      public CreateEventSubscriptionRequest withSourceType(String sourceType)

      The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

      Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

      Parameters:
      sourceType - The type of source that will be generating the events. For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account. You must specify a source type in order to specify source IDs.

      Valid values: cluster, cluster-parameter-group, cluster-security-group, and cluster-snapshot.

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

    • getSourceIds

      public List<String> getSourceIds()

      A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

      Returns:
      A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

    • setSourceIds

      public void setSourceIds(Collection<String> sourceIds)

      A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

      Parameters:
      sourceIds - A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

    • withSourceIds

      public CreateEventSubscriptionRequest withSourceIds(String... sourceIds)

      A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

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

      Parameters:
      sourceIds - A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

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

    • withSourceIds

      public CreateEventSubscriptionRequest withSourceIds(Collection<String> sourceIds)

      A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

      Parameters:
      sourceIds - A list of one or more identifiers of Amazon Redshift source objects. All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

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

    • getEventCategories

      public List<String> getEventCategories()

      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: Configuration, Management, Monitoring, Security

      Returns:
      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: Configuration, Management, Monitoring, Security

    • setEventCategories

      public void setEventCategories(Collection<String> eventCategories)

      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: Configuration, Management, Monitoring, Security

      Parameters:
      eventCategories - Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: Configuration, Management, Monitoring, Security

    • withEventCategories

      public CreateEventSubscriptionRequest withEventCategories(String... eventCategories)

      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: Configuration, Management, Monitoring, Security

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

      Parameters:
      eventCategories - Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: Configuration, Management, Monitoring, Security

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

    • withEventCategories

      public CreateEventSubscriptionRequest withEventCategories(Collection<String> eventCategories)

      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: Configuration, Management, Monitoring, Security

      Parameters:
      eventCategories - Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: Configuration, Management, Monitoring, Security

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

    • setSeverity

      public void setSeverity(String severity)

      Specifies the Amazon Redshift event severity to be published by the event notification subscription.

      Values: ERROR, INFO

      Parameters:
      severity - Specifies the Amazon Redshift event severity to be published by the event notification subscription.

      Values: ERROR, INFO

    • getSeverity

      public String getSeverity()

      Specifies the Amazon Redshift event severity to be published by the event notification subscription.

      Values: ERROR, INFO

      Returns:
      Specifies the Amazon Redshift event severity to be published by the event notification subscription.

      Values: ERROR, INFO

    • withSeverity

      public CreateEventSubscriptionRequest withSeverity(String severity)

      Specifies the Amazon Redshift event severity to be published by the event notification subscription.

      Values: ERROR, INFO

      Parameters:
      severity - Specifies the Amazon Redshift event severity to be published by the event notification subscription.

      Values: ERROR, INFO

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

    • setEnabled

      public void setEnabled(Boolean enabled)

      A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

      Parameters:
      enabled - A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

    • getEnabled

      public Boolean getEnabled()

      A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

      Returns:
      A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

    • withEnabled

      public CreateEventSubscriptionRequest withEnabled(Boolean enabled)

      A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

      Parameters:
      enabled - A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isEnabled

      public Boolean isEnabled()

      A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

      Returns:
      A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

    • getTags

      public List<Tag> getTags()

      A list of tag instances.

      Returns:
      A list of tag instances.

    • setTags

      public void setTags(Collection<Tag> tags)

      A list of tag instances.

      Parameters:
      tags - A list of tag instances.

    • withTags

      public CreateEventSubscriptionRequest withTags(Tag... tags)

      A list of tag instances.

      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 - A list of tag instances.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • withTags

      public CreateEventSubscriptionRequest withTags(Collection<Tag> tags)

      A list of tag instances.

      Parameters:
      tags - A list of tag instances.
      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; useful for testing and debugging.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this object.
      See Also:

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • clone

      public CreateEventSubscriptionRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: