CreateEventSubscriptionRequest (AWS SDK for Java

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)`
`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)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - subscriptionName
```
public 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 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 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.
    
    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.
  - sourceIds
```
public 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.
    
    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
  - eventCategories
```
public List<String> eventCategories()
```
    Specifies the Amazon Redshift event categories to be published by the event notification subscription.
    
    Values: configuration, management, monitoring, security
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    Specifies the Amazon Redshift event categories to be published by the event notification subscription.
    
    Values: configuration, management, monitoring, security
  - severity
```
public 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 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.
  - tags
```
public List<Tag> tags()
```
    A list of tag instances.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A list of tag instances.
  - toBuilder
```
public CreateEventSubscriptionRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>
    
    Specified by:
    
    toBuilder in class RedshiftRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateEventSubscriptionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateEventSubscriptionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

sourceIds

eventCategories

severity

enabled

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields