Interface CreateEventSubscriptionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateEventSubscriptionRequest.Builder,
,CreateEventSubscriptionRequest> RedshiftRequest.Builder
,SdkBuilder<CreateEventSubscriptionRequest.Builder,
,CreateEventSubscriptionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateEventSubscriptionRequest
-
Method Summary
Modifier and TypeMethodDescriptionA boolean value; set totrue
to activate the subscription, and set tofalse
to create the subscription but not activate it.eventCategories
(String... eventCategories) Specifies the Amazon Redshift event categories to be published by the event notification subscription.eventCategories
(Collection<String> eventCategories) Specifies the Amazon Redshift event categories to be published by the event notification subscription.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Specifies the Amazon Redshift event severity to be published by the event notification subscription.snsTopicArn
(String snsTopicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.A list of one or more identifiers of Amazon Redshift source objects.sourceIds
(Collection<String> sourceIds) A list of one or more identifiers of Amazon Redshift source objects.sourceType
(String sourceType) The type of source that will be generating the events.subscriptionName
(String subscriptionName) The name of the event subscription to be created.tags
(Collection<Tag> tags) A list of tag instances.tags
(Consumer<Tag.Builder>... tags) A list of tag instances.A list of tag instances.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.redshift.model.RedshiftRequest.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 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.
-
-
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.
-
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.
- 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 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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
eventCategories
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security, pending
- Parameters:
eventCategories
- Specifies the Amazon Redshift event categories to be published by the event notification subscription.Values: configuration, management, monitoring, security, pending
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventCategories
Specifies the Amazon Redshift event categories to be published by the event notification subscription.
Values: configuration, management, monitoring, security, pending
- Parameters:
eventCategories
- Specifies the Amazon Redshift event categories to be published by the event notification subscription.Values: configuration, management, monitoring, security, pending
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
enabled
A boolean value; set to
true
to activate the subscription, and set tofalse
to create the subscription but not activate it.- Parameters:
enabled
- A boolean value; set totrue
to activate the subscription, and set tofalse
to create the subscription but not activate it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
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.
-
tags
A list of tag instances.
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.
-