Class ModifyEventSubscriptionRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ModifyEventSubscriptionRequest.Builder,ModifyEventSubscriptionRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final Booleanenabled()Specifies whether to activate the subscription.final booleanfinal booleanequalsBySdkFields(Object obj) A list of event categories for a source type (SourceType) that you want to subscribe to.final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the EventCategories property.final inthashCode()static Class<? extends ModifyEventSubscriptionRequest.Builder>final StringThe Amazon Resource Name (ARN) of the SNS topic created for event notification.final StringThe type of source that is generating the events.final StringThe name of the RDS event notification subscription.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
subscriptionName
The name of the RDS event notification subscription.
- Returns:
- The name of the RDS event notification subscription.
-
snsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
- Returns:
- The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.
-
sourceType
The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify
db-proxy. If this value isn't specified, all events are returned.Valid Values:
db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment- Returns:
- The type of source that is generating the events. For example, if you want to be notified of events
generated by a DB instance, you would set this parameter to db-instance. For RDS Proxy events, specify
db-proxy. If this value isn't specified, all events are returned.Valid Values:
db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
-
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 theisEmpty()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
A list of event categories for a source type (
SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using theDescribeEventCategoriesoperation.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:
- A list of event categories for a source type (
SourceType) that you want to subscribe to. You can see a list of the categories for a given source type in Events in the Amazon RDS User Guide or by using theDescribeEventCategoriesoperation.
-
enabled
Specifies whether to activate the subscription.
- Returns:
- Specifies whether to activate the subscription.
-
toBuilder
- Specified by:
toBuilderin interfaceToCopyableBuilder<ModifyEventSubscriptionRequest.Builder,ModifyEventSubscriptionRequest> - Specified by:
toBuilderin classRdsRequest
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-