Interface CreateEventSubscriptionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateEventSubscriptionRequest.Builder,
,CreateEventSubscriptionRequest> RdsRequest.Builder
,SdkBuilder<CreateEventSubscriptionRequest.Builder,
,CreateEventSubscriptionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateEventSubscriptionRequest
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies whether to activate the subscription.eventCategories
(String... eventCategories) A list of event categories for a particular source type (SourceType
) that you want to subscribe to.eventCategories
(Collection<String> eventCategories) A list of event categories for a particular source type (SourceType
) that you want to subscribe to.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.snsTopicArn
(String snsTopicArn) The Amazon Resource Name (ARN) of the SNS topic created for event notification.The list of identifiers of the event sources for which events are returned.sourceIds
(Collection<String> sourceIds) The list of identifiers of the event sources for which events are returned.sourceType
(String sourceType) The type of source that is generating the events.subscriptionName
(String subscriptionName) The name of the subscription.tags
(Collection<Tag> tags) Sets the value of the Tags property for this object.tags
(Consumer<Tag.Builder>... tags) Sets the value of the Tags property for this object.Sets the value of the Tags property for this object.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.rds.model.RdsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
subscriptionName
The name of the subscription.
Constraints: The name must be less than 255 characters.
- Parameters:
subscriptionName
- The name of the subscription.Constraints: The name must be less than 255 characters.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.
RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
- Parameters:
snsTopicArn
- The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 set this parameter to
db-instance
. For RDS Proxy events, specifydb-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
- Parameters:
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 set this parameter todb-instance
. For RDS Proxy events, specifydb-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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventCategories
A list of event categories for a particular source type (
SourceType
) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using theDescribeEventCategories
operation.- Parameters:
eventCategories
- A list of event categories for a particular source type (SourceType
) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using theDescribeEventCategories
operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventCategories
A list of event categories for a particular source type (
SourceType
) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using theDescribeEventCategories
operation.- Parameters:
eventCategories
- A list of event categories for a particular source type (SourceType
) that you want to subscribe to. You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using theDescribeEventCategories
operation.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceIds
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
Constraints:
-
If
SourceIds
are supplied,SourceType
must also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied.
- Parameters:
sourceIds
- The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.Constraints:
-
If
SourceIds
are supplied,SourceType
must also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
sourceIds
The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.
Constraints:
-
If
SourceIds
are supplied,SourceType
must also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied.
- Parameters:
sourceIds
- The list of identifiers of the event sources for which events are returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.Constraints:
-
If
SourceIds
are supplied,SourceType
must also be provided. -
If the source type is a DB instance, a
DBInstanceIdentifier
value must be supplied. -
If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied. -
If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied. -
If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied. -
If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied. -
If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied. -
If the source type is an RDS Proxy, a
DBProxyName
value must be supplied.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
enabled
Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.
- Parameters:
enabled
- Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object.- Parameters:
tags
- The new value for the Tags property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object.- Parameters:
tags
- The new value for the Tags property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Sets the value of the Tags property for this object. This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateEventSubscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateEventSubscriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-