Interface UpdateArchiveRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<UpdateArchiveRequest.Builder,
,UpdateArchiveRequest> EventBridgeRequest.Builder
,SdkBuilder<UpdateArchiveRequest.Builder,
,UpdateArchiveRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
UpdateArchiveRequest
-
Method Summary
Modifier and TypeMethodDescriptionarchiveName
(String archiveName) The name of the archive to update.description
(String description) The description for the archive.eventPattern
(String eventPattern) The event pattern to use to filter events sent to the archive.kmsKeyIdentifier
(String kmsKeyIdentifier) The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.retentionDays
(Integer retentionDays) The number of days to retain events in the archive.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.eventbridge.model.EventBridgeRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
archiveName
The name of the archive to update.
- Parameters:
archiveName
- The name of the archive to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description for the archive.
- Parameters:
description
- The description for the archive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventPattern
The event pattern to use to filter events sent to the archive.
- Parameters:
eventPattern
- The event pattern to use to filter events sent to the archive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
retentionDays
The number of days to retain events in the archive.
- Parameters:
retentionDays
- The number of days to retain events in the archive.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKeyIdentifier
The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.
For more information, see Encrypting archives in the Amazon EventBridge User Guide.
- Parameters:
kmsKeyIdentifier
- The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt the archive.
For more information, see Identify and view keys in the Key Management Service Developer Guide.
If you have specified that EventBridge use a customer managed key for encrypting the source event bus, we strongly recommend you also specify a customer managed key for any archives for the event bus as well.
For more information, see Encrypting archives in the Amazon EventBridge User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
UpdateArchiveRequest.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
UpdateArchiveRequest.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.
-