CreateEventSubscriptionRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.redshift.model.RedshiftRequest
    - - software.amazon.awssdk.services.redshift.model.CreateEventSubscriptionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEventSubscriptionRequest
extends RedshiftRequest
implements ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateEventSubscriptionRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateEventSubscriptionRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateEventSubscriptionRequest.Builder`	`builder()`
`Boolean`	`enabled()` A boolean value; set to `true` to activate the subscription, and set to `false` to create the subscription but not activate it.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`eventCategories()` Specifies the Amazon Redshift event categories to be published by the event notification subscription.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEventCategories()` For responses, this returns true if the service returned a value for the EventCategories property.
`int`	`hashCode()`
`boolean`	`hasSourceIds()` For responses, this returns true if the service returned a value for the SourceIds property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateEventSubscriptionRequest.Builder>`	`serializableBuilderClass()`
`String`	`severity()` Specifies the Amazon Redshift event severity to be published by the event notification subscription.
`String`	`snsTopicArn()` The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.
`List<String>`	`sourceIds()` A list of one or more identifiers of Amazon Redshift source objects.
`String`	`sourceType()` The type of source that will be generating the events.
`String`	`subscriptionName()` The name of the event subscription to be created.
`List<Tag>`	`tags()` A list of tag instances.
`CreateEventSubscriptionRequest.Builder`	`toBuilder()`
`String`	`toString()` 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
  - subscriptionName
```
public final 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.
    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.
  - snsTopicArn
```
public final 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.
    
    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.
  - sourceType
```
public final 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 Amazon Web Services account. You must specify a source type in order to specify source IDs.
    
    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
    
    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 Amazon Web Services account. You must specify a source type in order to specify source IDs.
    
    Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.
  - hasSourceIds
```
public final boolean hasSourceIds()
```
    For responses, this returns true if the service returned a value for the SourceIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - sourceIds
```
public final List<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
    
    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 hasSourceIds() method.
    
    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
  - hasEventCategories
```
public final boolean hasEventCategories()
```
    For responses, this returns true if the service returned a value for the EventCategories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - eventCategories
```
public final List<String> eventCategories()
```
    Specifies the Amazon Redshift event categories to be published by the event notification subscription.
    
    Values: configuration, management, monitoring, security, pending
    
    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 hasEventCategories() method.
    
    Returns:
    
    Specifies the Amazon Redshift event categories to be published by the event notification subscription.
    
    Values: configuration, management, monitoring, security, pending
  - severity
```
public final String severity()
```
    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
  - enabled
```
public final Boolean enabled()
```
    A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
    
    Returns:
    
    A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.
  - 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 the isEmpty() 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()
```
    A list of tag instances.
    
    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:
    
    A list of tag instances.
  - toBuilder
```
public CreateEventSubscriptionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>
    
    Specified by:
    
    toBuilder in class RedshiftRequest
  - builder
```
public static CreateEventSubscriptionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateEventSubscriptionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateEventSubscriptionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

subscriptionName

snsTopicArn

sourceType

hasSourceIds

sourceIds

hasEventCategories

eventCategories

severity

enabled

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields