Interface WebhookEventsSourceConfiguration.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<WebhookEventsSourceConfiguration.Builder,,WebhookEventsSourceConfiguration> SdkBuilder<WebhookEventsSourceConfiguration.Builder,,WebhookEventsSourceConfiguration> SdkPojo
- Enclosing class:
WebhookEventsSourceConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionauthConfiguration(Consumer<WebhookAuthConfiguration.Builder> authConfiguration) How the provider authenticates its requests.authConfiguration(WebhookAuthConfiguration authConfiguration) How the provider authenticates its requests.deduplicationConfiguration(Consumer<WebhookDeduplicationConfiguration.Builder> deduplicationConfiguration) Optional.deduplicationConfiguration(WebhookDeduplicationConfiguration deduplicationConfiguration) Optional.kmsKeyIdentifier(String kmsKeyIdentifier) Optional.logConfiguration(Consumer<LogConfiguration.Builder> logConfiguration) Optional.logConfiguration(LogConfiguration logConfiguration) Optional.metadataHttpHeaders(String... metadataHttpHeaders) The HTTP request headers to add to each event's metadata, up to 20.metadataHttpHeaders(Collection<String> metadataHttpHeaders) The HTTP request headers to add to each event's metadata, up to 20.IAM role the service assumes to put the webhook's events on the event bus.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
authConfiguration
WebhookEventsSourceConfiguration.Builder authConfiguration(WebhookAuthConfiguration authConfiguration) How the provider authenticates its requests. Exactly one authentication type must be set, and it can't be changed after the EventSource is created.
- Parameters:
authConfiguration- How the provider authenticates its requests. Exactly one authentication type must be set, and it can't be changed after the EventSource is created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
authConfiguration
default WebhookEventsSourceConfiguration.Builder authConfiguration(Consumer<WebhookAuthConfiguration.Builder> authConfiguration) How the provider authenticates its requests. Exactly one authentication type must be set, and it can't be changed after the EventSource is created.
This is a convenience method that creates an instance of theWebhookAuthConfiguration.Builderavoiding the need to create one manually viaWebhookAuthConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toauthConfiguration(WebhookAuthConfiguration).- Parameters:
authConfiguration- a consumer that will call methods onWebhookAuthConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
kmsKeyIdentifier
Optional. The AWS KMS key that encrypts the EventSource's secret in AWS Secrets Manager. Omit it to encrypt the secret with the AWS managed key aws/secretsmanager. A key you supply must be an enabled customer managed key in your account and Region. Changing it re-encrypts the secret under the new key. The previous key can still decrypt the stored versions until the credential is next rotated.
- Parameters:
kmsKeyIdentifier- Optional. The AWS KMS key that encrypts the EventSource's secret in AWS Secrets Manager. Omit it to encrypt the secret with the AWS managed key aws/secretsmanager. A key you supply must be an enabled customer managed key in your account and Region. Changing it re-encrypts the secret under the new key. The previous key can still decrypt the stored versions until the credential is next rotated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleArn
IAM role the service assumes to put the webhook's events on the event bus. Must belong to the calling account.
- Parameters:
roleArn- IAM role the service assumes to put the webhook's events on the event bus. Must belong to the calling account.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metadataHttpHeaders
WebhookEventsSourceConfiguration.Builder metadataHttpHeaders(Collection<String> metadataHttpHeaders) The HTTP request headers to add to each event's metadata, up to 20. Header names are case-insensitive and can't repeat. Each header is added under its lowercase name. Omit the list to add no headers. Headers that carry credentials or that describe the network path, and the header that carries the static token, can't be listed.
- Parameters:
metadataHttpHeaders- The HTTP request headers to add to each event's metadata, up to 20. Header names are case-insensitive and can't repeat. Each header is added under its lowercase name. Omit the list to add no headers. Headers that carry credentials or that describe the network path, and the header that carries the static token, can't be listed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metadataHttpHeaders
The HTTP request headers to add to each event's metadata, up to 20. Header names are case-insensitive and can't repeat. Each header is added under its lowercase name. Omit the list to add no headers. Headers that carry credentials or that describe the network path, and the header that carries the static token, can't be listed.
- Parameters:
metadataHttpHeaders- The HTTP request headers to add to each event's metadata, up to 20. Header names are case-insensitive and can't repeat. Each header is added under its lowercase name. Omit the list to add no headers. Headers that carry credentials or that describe the network path, and the header that carries the static token, can't be listed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deduplicationConfiguration
WebhookEventsSourceConfiguration.Builder deduplicationConfiguration(WebhookDeduplicationConfiguration deduplicationConfiguration) Optional. Deduplicates this EventSource's events on the event bus. Omit it to deduplicate nothing.
- Parameters:
deduplicationConfiguration- Optional. Deduplicates this EventSource's events on the event bus. Omit it to deduplicate nothing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
deduplicationConfiguration
default WebhookEventsSourceConfiguration.Builder deduplicationConfiguration(Consumer<WebhookDeduplicationConfiguration.Builder> deduplicationConfiguration) Optional. Deduplicates this EventSource's events on the event bus. Omit it to deduplicate nothing.
This is a convenience method that creates an instance of theWebhookDeduplicationConfiguration.Builderavoiding the need to create one manually viaWebhookDeduplicationConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todeduplicationConfiguration(WebhookDeduplicationConfiguration).- Parameters:
deduplicationConfiguration- a consumer that will call methods onWebhookDeduplicationConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
logConfiguration
Optional. Controls the log records EventBridge delivers for this EventSource's webhook requests. Omit it to deliver no logs. Logs are delivered to the destinations you configure with Amazon CloudWatch Logs vended log delivery.
- Parameters:
logConfiguration- Optional. Controls the log records EventBridge delivers for this EventSource's webhook requests. Omit it to deliver no logs. Logs are delivered to the destinations you configure with Amazon CloudWatch Logs vended log delivery.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logConfiguration
default WebhookEventsSourceConfiguration.Builder logConfiguration(Consumer<LogConfiguration.Builder> logConfiguration) Optional. Controls the log records EventBridge delivers for this EventSource's webhook requests. Omit it to deliver no logs. Logs are delivered to the destinations you configure with Amazon CloudWatch Logs vended log delivery.
This is a convenience method that creates an instance of theLogConfiguration.Builderavoiding the need to create one manually viaLogConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tologConfiguration(LogConfiguration).- Parameters:
logConfiguration- a consumer that will call methods onLogConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-