@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface ShieldAsyncClient extends AwsClient
builder()
method.
This is the Shield Advanced API Reference. This guide is for developers who need detailed information about the Shield Advanced API actions, data types, and errors. For detailed information about WAF and Shield Advanced features and an overview of how to use the WAF and Shield Advanced APIs, see the WAF and Shield Developer Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateDrtLogBucketResponse> |
associateDRTLogBucket(AssociateDrtLogBucketRequest associateDrtLogBucketRequest)
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as
Application Load Balancer access logs, CloudFront logs, or logs from third party sources.
|
default CompletableFuture<AssociateDrtLogBucketResponse> |
associateDRTLogBucket(Consumer<AssociateDrtLogBucketRequest.Builder> associateDrtLogBucketRequest)
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as
Application Load Balancer access logs, CloudFront logs, or logs from third party sources.
|
default CompletableFuture<AssociateDrtRoleResponse> |
associateDRTRole(AssociateDrtRoleRequest associateDrtRoleRequest)
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to
assist with DDoS attack mitigation during potential attacks.
|
default CompletableFuture<AssociateDrtRoleResponse> |
associateDRTRole(Consumer<AssociateDrtRoleRequest.Builder> associateDrtRoleRequest)
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to
assist with DDoS attack mitigation during potential attacks.
|
default CompletableFuture<AssociateHealthCheckResponse> |
associateHealthCheck(AssociateHealthCheckRequest associateHealthCheckRequest)
Adds health-based detection to the Shield Advanced protection for a resource.
|
default CompletableFuture<AssociateHealthCheckResponse> |
associateHealthCheck(Consumer<AssociateHealthCheckRequest.Builder> associateHealthCheckRequest)
Adds health-based detection to the Shield Advanced protection for a resource.
|
default CompletableFuture<AssociateProactiveEngagementDetailsResponse> |
associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest associateProactiveEngagementDetailsRequest)
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.
|
default CompletableFuture<AssociateProactiveEngagementDetailsResponse> |
associateProactiveEngagementDetails(Consumer<AssociateProactiveEngagementDetailsRequest.Builder> associateProactiveEngagementDetailsRequest)
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use.
|
static ShieldAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
ShieldAsyncClient. |
static ShieldAsyncClient |
create()
Create a
ShieldAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateProtectionResponse> |
createProtection(Consumer<CreateProtectionRequest.Builder> createProtectionRequest)
Enables Shield Advanced for a specific Amazon Web Services resource.
|
default CompletableFuture<CreateProtectionResponse> |
createProtection(CreateProtectionRequest createProtectionRequest)
Enables Shield Advanced for a specific Amazon Web Services resource.
|
default CompletableFuture<CreateProtectionGroupResponse> |
createProtectionGroup(Consumer<CreateProtectionGroupRequest.Builder> createProtectionGroupRequest)
Creates a grouping of protected resources so they can be handled as a collective.
|
default CompletableFuture<CreateProtectionGroupResponse> |
createProtectionGroup(CreateProtectionGroupRequest createProtectionGroupRequest)
Creates a grouping of protected resources so they can be handled as a collective.
|
default CompletableFuture<CreateSubscriptionResponse> |
createSubscription()
Activates Shield Advanced for an account.
|
default CompletableFuture<CreateSubscriptionResponse> |
createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest)
Activates Shield Advanced for an account.
|
default CompletableFuture<CreateSubscriptionResponse> |
createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
Activates Shield Advanced for an account.
|
default CompletableFuture<DeleteProtectionResponse> |
deleteProtection(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest)
Deletes an Shield Advanced Protection.
|
default CompletableFuture<DeleteProtectionResponse> |
deleteProtection(DeleteProtectionRequest deleteProtectionRequest)
Deletes an Shield Advanced Protection.
|
default CompletableFuture<DeleteProtectionGroupResponse> |
deleteProtectionGroup(Consumer<DeleteProtectionGroupRequest.Builder> deleteProtectionGroupRequest)
Removes the specified protection group.
|
default CompletableFuture<DeleteProtectionGroupResponse> |
deleteProtectionGroup(DeleteProtectionGroupRequest deleteProtectionGroupRequest)
Removes the specified protection group.
|
default CompletableFuture<DescribeAttackResponse> |
describeAttack(Consumer<DescribeAttackRequest.Builder> describeAttackRequest)
Describes the details of a DDoS attack.
|
default CompletableFuture<DescribeAttackResponse> |
describeAttack(DescribeAttackRequest describeAttackRequest)
Describes the details of a DDoS attack.
|
default CompletableFuture<DescribeAttackStatisticsResponse> |
describeAttackStatistics(Consumer<DescribeAttackStatisticsRequest.Builder> describeAttackStatisticsRequest)
Provides information about the number and type of attacks Shield has detected in the last year for all resources
that belong to your account, regardless of whether you've defined Shield protections for them.
|
default CompletableFuture<DescribeAttackStatisticsResponse> |
describeAttackStatistics(DescribeAttackStatisticsRequest describeAttackStatisticsRequest)
Provides information about the number and type of attacks Shield has detected in the last year for all resources
that belong to your account, regardless of whether you've defined Shield protections for them.
|
default CompletableFuture<DescribeDrtAccessResponse> |
describeDRTAccess(Consumer<DescribeDrtAccessRequest.Builder> describeDrtAccessRequest)
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your
Amazon Web Services account while assisting with attack mitigation.
|
default CompletableFuture<DescribeDrtAccessResponse> |
describeDRTAccess(DescribeDrtAccessRequest describeDrtAccessRequest)
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your
Amazon Web Services account while assisting with attack mitigation.
|
default CompletableFuture<DescribeEmergencyContactSettingsResponse> |
describeEmergencyContactSettings(Consumer<DescribeEmergencyContactSettingsRequest.Builder> describeEmergencyContactSettingsRequest)
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you
have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
|
default CompletableFuture<DescribeEmergencyContactSettingsResponse> |
describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest)
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you
have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
|
default CompletableFuture<DescribeProtectionResponse> |
describeProtection(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest)
Lists the details of a Protection object.
|
default CompletableFuture<DescribeProtectionResponse> |
describeProtection(DescribeProtectionRequest describeProtectionRequest)
Lists the details of a Protection object.
|
default CompletableFuture<DescribeProtectionGroupResponse> |
describeProtectionGroup(Consumer<DescribeProtectionGroupRequest.Builder> describeProtectionGroupRequest)
Returns the specification for the specified protection group.
|
default CompletableFuture<DescribeProtectionGroupResponse> |
describeProtectionGroup(DescribeProtectionGroupRequest describeProtectionGroupRequest)
Returns the specification for the specified protection group.
|
default CompletableFuture<DescribeSubscriptionResponse> |
describeSubscription()
Provides details about the Shield Advanced subscription for an account.
|
default CompletableFuture<DescribeSubscriptionResponse> |
describeSubscription(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest)
Provides details about the Shield Advanced subscription for an account.
|
default CompletableFuture<DescribeSubscriptionResponse> |
describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)
Provides details about the Shield Advanced subscription for an account.
|
default CompletableFuture<DisableApplicationLayerAutomaticResponseResponse> |
disableApplicationLayerAutomaticResponse(Consumer<DisableApplicationLayerAutomaticResponseRequest.Builder> disableApplicationLayerAutomaticResponseRequest)
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.
|
default CompletableFuture<DisableApplicationLayerAutomaticResponseResponse> |
disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest disableApplicationLayerAutomaticResponseRequest)
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource.
|
default CompletableFuture<DisableProactiveEngagementResponse> |
disableProactiveEngagement(Consumer<DisableProactiveEngagementRequest.Builder> disableProactiveEngagementRequest)
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to
initiate proactive customer support.
|
default CompletableFuture<DisableProactiveEngagementResponse> |
disableProactiveEngagement(DisableProactiveEngagementRequest disableProactiveEngagementRequest)
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to
initiate proactive customer support.
|
default CompletableFuture<DisassociateDrtLogBucketResponse> |
disassociateDRTLogBucket(Consumer<DisassociateDrtLogBucketRequest.Builder> disassociateDrtLogBucketRequest)
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you
shared previously.
|
default CompletableFuture<DisassociateDrtLogBucketResponse> |
disassociateDRTLogBucket(DisassociateDrtLogBucketRequest disassociateDrtLogBucketRequest)
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you
shared previously.
|
default CompletableFuture<DisassociateDrtRoleResponse> |
disassociateDRTRole()
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
|
default CompletableFuture<DisassociateDrtRoleResponse> |
disassociateDRTRole(Consumer<DisassociateDrtRoleRequest.Builder> disassociateDrtRoleRequest)
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
|
default CompletableFuture<DisassociateDrtRoleResponse> |
disassociateDRTRole(DisassociateDrtRoleRequest disassociateDrtRoleRequest)
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
|
default CompletableFuture<DisassociateHealthCheckResponse> |
disassociateHealthCheck(Consumer<DisassociateHealthCheckRequest.Builder> disassociateHealthCheckRequest)
Removes health-based detection from the Shield Advanced protection for a resource.
|
default CompletableFuture<DisassociateHealthCheckResponse> |
disassociateHealthCheck(DisassociateHealthCheckRequest disassociateHealthCheckRequest)
Removes health-based detection from the Shield Advanced protection for a resource.
|
default CompletableFuture<EnableApplicationLayerAutomaticResponseResponse> |
enableApplicationLayerAutomaticResponse(Consumer<EnableApplicationLayerAutomaticResponseRequest.Builder> enableApplicationLayerAutomaticResponseRequest)
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
|
default CompletableFuture<EnableApplicationLayerAutomaticResponseResponse> |
enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest enableApplicationLayerAutomaticResponseRequest)
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
|
default CompletableFuture<EnableProactiveEngagementResponse> |
enableProactiveEngagement(Consumer<EnableProactiveEngagementRequest.Builder> enableProactiveEngagementRequest)
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT
and to initiate proactive customer support.
|
default CompletableFuture<EnableProactiveEngagementResponse> |
enableProactiveEngagement(EnableProactiveEngagementRequest enableProactiveEngagementRequest)
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT
and to initiate proactive customer support.
|
default CompletableFuture<GetSubscriptionStateResponse> |
getSubscriptionState()
Returns the
SubscriptionState, either Active or Inactive. |
default CompletableFuture<GetSubscriptionStateResponse> |
getSubscriptionState(Consumer<GetSubscriptionStateRequest.Builder> getSubscriptionStateRequest)
Returns the
SubscriptionState, either Active or Inactive. |
default CompletableFuture<GetSubscriptionStateResponse> |
getSubscriptionState(GetSubscriptionStateRequest getSubscriptionStateRequest)
Returns the
SubscriptionState, either Active or Inactive. |
default CompletableFuture<ListAttacksResponse> |
listAttacks()
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default CompletableFuture<ListAttacksResponse> |
listAttacks(Consumer<ListAttacksRequest.Builder> listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default CompletableFuture<ListAttacksResponse> |
listAttacks(ListAttacksRequest listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default ListAttacksPublisher |
listAttacksPaginator()
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default ListAttacksPublisher |
listAttacksPaginator(Consumer<ListAttacksRequest.Builder> listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default ListAttacksPublisher |
listAttacksPaginator(ListAttacksRequest listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
|
default CompletableFuture<ListProtectionGroupsResponse> |
listProtectionGroups(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest)
Retrieves ProtectionGroup objects for the account.
|
default CompletableFuture<ListProtectionGroupsResponse> |
listProtectionGroups(ListProtectionGroupsRequest listProtectionGroupsRequest)
Retrieves ProtectionGroup objects for the account.
|
default ListProtectionGroupsPublisher |
listProtectionGroupsPaginator(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest)
Retrieves ProtectionGroup objects for the account.
|
default ListProtectionGroupsPublisher |
listProtectionGroupsPaginator(ListProtectionGroupsRequest listProtectionGroupsRequest)
Retrieves ProtectionGroup objects for the account.
|
default CompletableFuture<ListProtectionsResponse> |
listProtections()
Retrieves Protection objects for the account.
|
default CompletableFuture<ListProtectionsResponse> |
listProtections(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest)
Retrieves Protection objects for the account.
|
default CompletableFuture<ListProtectionsResponse> |
listProtections(ListProtectionsRequest listProtectionsRequest)
Retrieves Protection objects for the account.
|
default ListProtectionsPublisher |
listProtectionsPaginator()
Retrieves Protection objects for the account.
|
default ListProtectionsPublisher |
listProtectionsPaginator(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest)
Retrieves Protection objects for the account.
|
default ListProtectionsPublisher |
listProtectionsPaginator(ListProtectionsRequest listProtectionsRequest)
Retrieves Protection objects for the account.
|
default CompletableFuture<ListResourcesInProtectionGroupResponse> |
listResourcesInProtectionGroup(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest)
Retrieves the resources that are included in the protection group.
|
default CompletableFuture<ListResourcesInProtectionGroupResponse> |
listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest)
Retrieves the resources that are included in the protection group.
|
default ListResourcesInProtectionGroupPublisher |
listResourcesInProtectionGroupPaginator(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest)
Retrieves the resources that are included in the protection group.
|
default ListResourcesInProtectionGroupPublisher |
listResourcesInProtectionGroupPaginator(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest)
Retrieves the resources that are included in the protection group.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
|
default ShieldServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates tags for a resource in Shield.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for a resource in Shield.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a resource in Shield.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource in Shield.
|
default CompletableFuture<UpdateApplicationLayerAutomaticResponseResponse> |
updateApplicationLayerAutomaticResponse(Consumer<UpdateApplicationLayerAutomaticResponseRequest.Builder> updateApplicationLayerAutomaticResponseRequest)
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified
resource.
|
default CompletableFuture<UpdateApplicationLayerAutomaticResponseResponse> |
updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest updateApplicationLayerAutomaticResponseRequest)
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified
resource.
|
default CompletableFuture<UpdateEmergencyContactSettingsResponse> |
updateEmergencyContactSettings(Consumer<UpdateEmergencyContactSettingsRequest.Builder> updateEmergencyContactSettingsRequest)
Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use
to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive
customer support.
|
default CompletableFuture<UpdateEmergencyContactSettingsResponse> |
updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest)
Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use
to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive
customer support.
|
default CompletableFuture<UpdateProtectionGroupResponse> |
updateProtectionGroup(Consumer<UpdateProtectionGroupRequest.Builder> updateProtectionGroupRequest)
Updates an existing protection group.
|
default CompletableFuture<UpdateProtectionGroupResponse> |
updateProtectionGroup(UpdateProtectionGroupRequest updateProtectionGroupRequest)
Updates an existing protection group.
|
default CompletableFuture<UpdateSubscriptionResponse> |
updateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest)
Updates the details of an existing subscription.
|
default CompletableFuture<UpdateSubscriptionResponse> |
updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest)
Updates the details of an existing subscription.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<AssociateDrtLogBucketResponse> associateDRTLogBucket(AssociateDrtLogBucketRequest associateDrtLogBucketRequest)
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to
the Business Support plan or the Enterprise Support plan.
associateDrtLogBucketRequest - iam:PassRole permission. This error
indicates the user did not have the appropriate permissions. For more information, see Granting a User
Permissions to Pass a Role to an Amazon Web Services Service.default CompletableFuture<AssociateDrtLogBucketResponse> associateDRTLogBucket(Consumer<AssociateDrtLogBucketRequest.Builder> associateDrtLogBucketRequest)
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. You can associate up to 10 Amazon S3 buckets with your subscription.
To use the services of the SRT and make an AssociateDRTLogBucket request, you must be subscribed to
the Business Support plan or the Enterprise Support plan.
This is a convenience which creates an instance of the AssociateDrtLogBucketRequest.Builder avoiding the
need to create one manually via AssociateDrtLogBucketRequest.builder()
associateDrtLogBucketRequest - A Consumer that will call methods on AssociateDRTLogBucketRequest.Builder to create a
request.iam:PassRole permission. This error
indicates the user did not have the appropriate permissions. For more information, see Granting a User
Permissions to Pass a Role to an Amazon Web Services Service.default CompletableFuture<AssociateDrtRoleResponse> associateDRTRole(AssociateDrtRoleRequest associateDrtRoleRequest)
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
You can associate only one RoleArn with your subscription. If you submit an
AssociateDRTRole request for an account that already has an associated role, the new
RoleArn will replace the existing RoleArn.
Prior to making the AssociateDRTRole request, you must attach the
AWSShieldDRTAccessPolicy managed policy to the role that you'll specify in the request. You can
access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and
removing IAM identity permissions. The role must also trust the service principal
drt.shield.amazonaws.com. For more information, see IAM JSON
policy elements: Principal.
The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
You must have the iam:PassRole permission to make an AssociateDRTRole request. For more
information, see Granting a
user permissions to pass a role to an Amazon Web Services service.
To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the
Business Support plan or the Enterprise Support plan.
associateDrtRoleRequest - iam:PassRole permission. This error
indicates the user did not have the appropriate permissions. For more information, see Granting a User
Permissions to Pass a Role to an Amazon Web Services Service.default CompletableFuture<AssociateDrtRoleResponse> associateDRTRole(Consumer<AssociateDrtRoleRequest.Builder> associateDrtRoleRequest)
Authorizes the Shield Response Team (SRT) using the specified role, to access your Amazon Web Services account to assist with DDoS attack mitigation during potential attacks. This enables the SRT to inspect your WAF configuration and create or update WAF rules and web ACLs.
You can associate only one RoleArn with your subscription. If you submit an
AssociateDRTRole request for an account that already has an associated role, the new
RoleArn will replace the existing RoleArn.
Prior to making the AssociateDRTRole request, you must attach the
AWSShieldDRTAccessPolicy managed policy to the role that you'll specify in the request. You can
access this policy in the IAM console at AWSShieldDRTAccessPolicy. For more information see Adding and
removing IAM identity permissions. The role must also trust the service principal
drt.shield.amazonaws.com. For more information, see IAM JSON
policy elements: Principal.
The SRT will have access only to your WAF and Shield resources. By submitting this request, you authorize the SRT to inspect your WAF and Shield configuration and create and update WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
You must have the iam:PassRole permission to make an AssociateDRTRole request. For more
information, see Granting a
user permissions to pass a role to an Amazon Web Services service.
To use the services of the SRT and make an AssociateDRTRole request, you must be subscribed to the
Business Support plan or the Enterprise Support plan.
This is a convenience which creates an instance of the AssociateDrtRoleRequest.Builder avoiding the need
to create one manually via AssociateDrtRoleRequest.builder()
associateDrtRoleRequest - A Consumer that will call methods on AssociateDRTRoleRequest.Builder to create a request.iam:PassRole permission. This error
indicates the user did not have the appropriate permissions. For more information, see Granting a User
Permissions to Pass a Role to an Amazon Web Services Service.default CompletableFuture<AssociateHealthCheckResponse> associateHealthCheck(AssociateHealthCheckRequest associateHealthCheckRequest)
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
associateHealthCheckRequest - default CompletableFuture<AssociateHealthCheckResponse> associateHealthCheck(Consumer<AssociateHealthCheckRequest.Builder> associateHealthCheckRequest)
Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
This is a convenience which creates an instance of the AssociateHealthCheckRequest.Builder avoiding the
need to create one manually via AssociateHealthCheckRequest.builder()
associateHealthCheckRequest - A Consumer that will call methods on AssociateHealthCheckRequest.Builder to create a
request.default CompletableFuture<AssociateProactiveEngagementDetailsResponse> associateProactiveEngagementDetails(AssociateProactiveEngagementDetailsRequest associateProactiveEngagementDetailsRequest)
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use
the calls DisableProactiveEngagement and EnableProactiveEngagement.
This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already defined. If you already have
contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and
then provide it to this call.
associateProactiveEngagementDetailsRequest - default CompletableFuture<AssociateProactiveEngagementDetailsResponse> associateProactiveEngagementDetails(Consumer<AssociateProactiveEngagementDetailsRequest.Builder> associateProactiveEngagementDetailsRequest)
Initializes proactive engagement and sets the list of contacts for the Shield Response Team (SRT) to use. You must provide at least one phone number in the emergency contact list.
After you have initialized proactive engagement using this call, to disable or enable proactive engagement, use
the calls DisableProactiveEngagement and EnableProactiveEngagement.
This call defines the list of email addresses and phone numbers that the SRT can use to contact you for escalations to the SRT and to initiate proactive customer support.
The contacts that you provide in the request replace any contacts that were already defined. If you already have
contacts defined and want to use them, retrieve the list using DescribeEmergencyContactSettings and
then provide it to this call.
This is a convenience which creates an instance of the AssociateProactiveEngagementDetailsRequest.Builder
avoiding the need to create one manually via AssociateProactiveEngagementDetailsRequest.builder()
associateProactiveEngagementDetailsRequest - A Consumer that will call methods on AssociateProactiveEngagementDetailsRequest.Builder to
create a request.default CompletableFuture<CreateProtectionResponse> createProtection(CreateProtectionRequest createProtectionRequest)
Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each CreateProtection request. You can add
protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For
more information see Getting Started with
Shield Advanced and Adding Shield Advanced
protection to Amazon Web Services resources.
createProtectionRequest - default CompletableFuture<CreateProtectionResponse> createProtection(Consumer<CreateProtectionRequest.Builder> createProtectionRequest)
Enables Shield Advanced for a specific Amazon Web Services resource. The resource can be an Amazon CloudFront distribution, Amazon Route 53 hosted zone, Global Accelerator standard accelerator, Elastic IP Address, Application Load Balancer, or a Classic Load Balancer. You can protect Amazon EC2 instances and Network Load Balancers by association with protected Amazon EC2 Elastic IP addresses.
You can add protection to only a single resource with each CreateProtection request. You can add
protection to multiple resources at once through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For
more information see Getting Started with
Shield Advanced and Adding Shield Advanced
protection to Amazon Web Services resources.
This is a convenience which creates an instance of the CreateProtectionRequest.Builder avoiding the need
to create one manually via CreateProtectionRequest.builder()
createProtectionRequest - A Consumer that will call methods on CreateProtectionRequest.Builder to create a request.default CompletableFuture<CreateProtectionGroupResponse> createProtectionGroup(CreateProtectionGroupRequest createProtectionGroupRequest)
Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
createProtectionGroupRequest - default CompletableFuture<CreateProtectionGroupResponse> createProtectionGroup(Consumer<CreateProtectionGroupRequest.Builder> createProtectionGroupRequest)
Creates a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
This is a convenience which creates an instance of the CreateProtectionGroupRequest.Builder avoiding the
need to create one manually via CreateProtectionGroupRequest.builder()
createProtectionGroupRequest - A Consumer that will call methods on CreateProtectionGroupRequest.Builder to create a
request.default CompletableFuture<CreateSubscriptionResponse> createSubscription(CreateSubscriptionRequest createSubscriptionRequest)
Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically renewed at the end of the
existing subscription period. You can change this by submitting an UpdateSubscription request.
createSubscriptionRequest - default CompletableFuture<CreateSubscriptionResponse> createSubscription(Consumer<CreateSubscriptionRequest.Builder> createSubscriptionRequest)
Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically renewed at the end of the
existing subscription period. You can change this by submitting an UpdateSubscription request.
This is a convenience which creates an instance of the CreateSubscriptionRequest.Builder avoiding the
need to create one manually via CreateSubscriptionRequest.builder()
createSubscriptionRequest - A Consumer that will call methods on CreateSubscriptionRequest.Builder to create a
request.default CompletableFuture<CreateSubscriptionResponse> createSubscription()
Activates Shield Advanced for an account.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
When you initially create a subscription, your subscription is set to be automatically renewed at the end of the
existing subscription period. You can change this by submitting an UpdateSubscription request.
default CompletableFuture<DeleteProtectionResponse> deleteProtection(DeleteProtectionRequest deleteProtectionRequest)
Deletes an Shield Advanced Protection.
deleteProtectionRequest - default CompletableFuture<DeleteProtectionResponse> deleteProtection(Consumer<DeleteProtectionRequest.Builder> deleteProtectionRequest)
Deletes an Shield Advanced Protection.
This is a convenience which creates an instance of the DeleteProtectionRequest.Builder avoiding the need
to create one manually via DeleteProtectionRequest.builder()
deleteProtectionRequest - A Consumer that will call methods on DeleteProtectionRequest.Builder to create a request.default CompletableFuture<DeleteProtectionGroupResponse> deleteProtectionGroup(DeleteProtectionGroupRequest deleteProtectionGroupRequest)
Removes the specified protection group.
deleteProtectionGroupRequest - default CompletableFuture<DeleteProtectionGroupResponse> deleteProtectionGroup(Consumer<DeleteProtectionGroupRequest.Builder> deleteProtectionGroupRequest)
Removes the specified protection group.
This is a convenience which creates an instance of the DeleteProtectionGroupRequest.Builder avoiding the
need to create one manually via DeleteProtectionGroupRequest.builder()
deleteProtectionGroupRequest - A Consumer that will call methods on DeleteProtectionGroupRequest.Builder to create a
request.default CompletableFuture<DescribeAttackResponse> describeAttack(DescribeAttackRequest describeAttackRequest)
Describes the details of a DDoS attack.
describeAttackRequest - AttackId does not exist, or
the requester does not have the appropriate permissions to access the AttackId.default CompletableFuture<DescribeAttackResponse> describeAttack(Consumer<DescribeAttackRequest.Builder> describeAttackRequest)
Describes the details of a DDoS attack.
This is a convenience which creates an instance of the DescribeAttackRequest.Builder avoiding the need to
create one manually via DescribeAttackRequest.builder()
describeAttackRequest - A Consumer that will call methods on DescribeAttackRequest.Builder to create a request.AttackId does not exist, or
the requester does not have the appropriate permissions to access the AttackId.default CompletableFuture<DescribeAttackStatisticsResponse> describeAttackStatistics(DescribeAttackStatisticsRequest describeAttackStatisticsRequest)
Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example,
if the current time is 2020-10-26 15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then
the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to
2020-10-26 00:00:00 UTC.
The time range indicates the period covered by the attack statistics data items.
describeAttackStatisticsRequest - default CompletableFuture<DescribeAttackStatisticsResponse> describeAttackStatistics(Consumer<DescribeAttackStatisticsRequest.Builder> describeAttackStatisticsRequest)
Provides information about the number and type of attacks Shield has detected in the last year for all resources that belong to your account, regardless of whether you've defined Shield protections for them. This operation is available to Shield customers as well as to Shield Advanced customers.
The operation returns data for the time range of midnight UTC, one year ago, to midnight UTC, today. For example,
if the current time is 2020-10-26 15:39:32 PDT, equal to 2020-10-26 22:39:32 UTC, then
the time range for the attack data returned is from 2019-10-26 00:00:00 UTC to
2020-10-26 00:00:00 UTC.
The time range indicates the period covered by the attack statistics data items.
This is a convenience which creates an instance of the DescribeAttackStatisticsRequest.Builder avoiding
the need to create one manually via DescribeAttackStatisticsRequest.builder()
describeAttackStatisticsRequest - A Consumer that will call methods on DescribeAttackStatisticsRequest.Builder to create a
request.default CompletableFuture<DescribeDrtAccessResponse> describeDRTAccess(DescribeDrtAccessRequest describeDrtAccessRequest)
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
describeDrtAccessRequest - default CompletableFuture<DescribeDrtAccessResponse> describeDRTAccess(Consumer<DescribeDrtAccessRequest.Builder> describeDrtAccessRequest)
Returns the current role and list of Amazon S3 log buckets used by the Shield Response Team (SRT) to access your Amazon Web Services account while assisting with attack mitigation.
This is a convenience which creates an instance of the DescribeDrtAccessRequest.Builder avoiding the need
to create one manually via DescribeDrtAccessRequest.builder()
describeDrtAccessRequest - A Consumer that will call methods on DescribeDRTAccessRequest.Builder to create a request.default CompletableFuture<DescribeEmergencyContactSettingsResponse> describeEmergencyContactSettings(DescribeEmergencyContactSettingsRequest describeEmergencyContactSettingsRequest)
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
describeEmergencyContactSettingsRequest - default CompletableFuture<DescribeEmergencyContactSettingsResponse> describeEmergencyContactSettings(Consumer<DescribeEmergencyContactSettingsRequest.Builder> describeEmergencyContactSettingsRequest)
A list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
This is a convenience which creates an instance of the DescribeEmergencyContactSettingsRequest.Builder
avoiding the need to create one manually via DescribeEmergencyContactSettingsRequest.builder()
describeEmergencyContactSettingsRequest - A Consumer that will call methods on DescribeEmergencyContactSettingsRequest.Builder to
create a request.default CompletableFuture<DescribeProtectionResponse> describeProtection(DescribeProtectionRequest describeProtectionRequest)
Lists the details of a Protection object.
describeProtectionRequest - default CompletableFuture<DescribeProtectionResponse> describeProtection(Consumer<DescribeProtectionRequest.Builder> describeProtectionRequest)
Lists the details of a Protection object.
This is a convenience which creates an instance of the DescribeProtectionRequest.Builder avoiding the
need to create one manually via DescribeProtectionRequest.builder()
describeProtectionRequest - A Consumer that will call methods on DescribeProtectionRequest.Builder to create a
request.default CompletableFuture<DescribeProtectionGroupResponse> describeProtectionGroup(DescribeProtectionGroupRequest describeProtectionGroupRequest)
Returns the specification for the specified protection group.
describeProtectionGroupRequest - default CompletableFuture<DescribeProtectionGroupResponse> describeProtectionGroup(Consumer<DescribeProtectionGroupRequest.Builder> describeProtectionGroupRequest)
Returns the specification for the specified protection group.
This is a convenience which creates an instance of the DescribeProtectionGroupRequest.Builder avoiding
the need to create one manually via DescribeProtectionGroupRequest.builder()
describeProtectionGroupRequest - A Consumer that will call methods on DescribeProtectionGroupRequest.Builder to create a
request.default CompletableFuture<DescribeSubscriptionResponse> describeSubscription(DescribeSubscriptionRequest describeSubscriptionRequest)
Provides details about the Shield Advanced subscription for an account.
describeSubscriptionRequest - default CompletableFuture<DescribeSubscriptionResponse> describeSubscription(Consumer<DescribeSubscriptionRequest.Builder> describeSubscriptionRequest)
Provides details about the Shield Advanced subscription for an account.
This is a convenience which creates an instance of the DescribeSubscriptionRequest.Builder avoiding the
need to create one manually via DescribeSubscriptionRequest.builder()
describeSubscriptionRequest - A Consumer that will call methods on DescribeSubscriptionRequest.Builder to create a
request.default CompletableFuture<DescribeSubscriptionResponse> describeSubscription()
Provides details about the Shield Advanced subscription for an account.
default CompletableFuture<DisableApplicationLayerAutomaticResponseResponse> disableApplicationLayerAutomaticResponse(DisableApplicationLayerAutomaticResponseRequest disableApplicationLayerAutomaticResponseRequest)
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.
disableApplicationLayerAutomaticResponseRequest - default CompletableFuture<DisableApplicationLayerAutomaticResponseResponse> disableApplicationLayerAutomaticResponse(Consumer<DisableApplicationLayerAutomaticResponseRequest.Builder> disableApplicationLayerAutomaticResponseRequest)
Disable the Shield Advanced automatic application layer DDoS mitigation feature for the protected resource. This stops Shield Advanced from creating, verifying, and applying WAF rules for attacks that it detects for the resource.
This is a convenience which creates an instance of the
DisableApplicationLayerAutomaticResponseRequest.Builder avoiding the need to create one manually via
DisableApplicationLayerAutomaticResponseRequest.builder()
disableApplicationLayerAutomaticResponseRequest - A Consumer that will call methods on
DisableApplicationLayerAutomaticResponseRequest.Builder to create a request.default CompletableFuture<DisableProactiveEngagementResponse> disableProactiveEngagement(DisableProactiveEngagementRequest disableProactiveEngagementRequest)
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
disableProactiveEngagementRequest - default CompletableFuture<DisableProactiveEngagementResponse> disableProactiveEngagement(Consumer<DisableProactiveEngagementRequest.Builder> disableProactiveEngagementRequest)
Removes authorization from the Shield Response Team (SRT) to notify contacts about escalations to the SRT and to initiate proactive customer support.
This is a convenience which creates an instance of the DisableProactiveEngagementRequest.Builder avoiding
the need to create one manually via DisableProactiveEngagementRequest.builder()
disableProactiveEngagementRequest - A Consumer that will call methods on DisableProactiveEngagementRequest.Builder to create a
request.default CompletableFuture<DisassociateDrtLogBucketResponse> disassociateDRTLogBucket(DisassociateDrtLogBucketRequest disassociateDrtLogBucketRequest)
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
disassociateDrtLogBucketRequest - iam:PassRole permission. This error
indicates the user did not have the appropriate permissions. For more information, see Granting a User
Permissions to Pass a Role to an Amazon Web Services Service.default CompletableFuture<DisassociateDrtLogBucketResponse> disassociateDRTLogBucket(Consumer<DisassociateDrtLogBucketRequest.Builder> disassociateDrtLogBucketRequest)
Removes the Shield Response Team's (SRT) access to the specified Amazon S3 bucket containing the logs that you shared previously.
This is a convenience which creates an instance of the DisassociateDrtLogBucketRequest.Builder avoiding
the need to create one manually via DisassociateDrtLogBucketRequest.builder()
disassociateDrtLogBucketRequest - A Consumer that will call methods on DisassociateDRTLogBucketRequest.Builder to create a
request.iam:PassRole permission. This error
indicates the user did not have the appropriate permissions. For more information, see Granting a User
Permissions to Pass a Role to an Amazon Web Services Service.default CompletableFuture<DisassociateDrtRoleResponse> disassociateDRTRole(DisassociateDrtRoleRequest disassociateDrtRoleRequest)
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
disassociateDrtRoleRequest - default CompletableFuture<DisassociateDrtRoleResponse> disassociateDRTRole(Consumer<DisassociateDrtRoleRequest.Builder> disassociateDrtRoleRequest)
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
This is a convenience which creates an instance of the DisassociateDrtRoleRequest.Builder avoiding the
need to create one manually via DisassociateDrtRoleRequest.builder()
disassociateDrtRoleRequest - A Consumer that will call methods on DisassociateDRTRoleRequest.Builder to create a
request.default CompletableFuture<DisassociateDrtRoleResponse> disassociateDRTRole()
Removes the Shield Response Team's (SRT) access to your Amazon Web Services account.
default CompletableFuture<DisassociateHealthCheckResponse> disassociateHealthCheck(DisassociateHealthCheckRequest disassociateHealthCheckRequest)
Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
disassociateHealthCheckRequest - default CompletableFuture<DisassociateHealthCheckResponse> disassociateHealthCheck(Consumer<DisassociateHealthCheckRequest.Builder> disassociateHealthCheckRequest)
Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your Amazon Web Services resource to improve responsiveness and accuracy in attack detection and response.
You define the health check in Route 53 and then associate or disassociate it with your Shield Advanced protection. For more information, see Shield Advanced Health-Based Detection in the WAF Developer Guide.
This is a convenience which creates an instance of the DisassociateHealthCheckRequest.Builder avoiding
the need to create one manually via DisassociateHealthCheckRequest.builder()
disassociateHealthCheckRequest - A Consumer that will call methods on DisassociateHealthCheckRequest.Builder to create a
request.default CompletableFuture<EnableApplicationLayerAutomaticResponseResponse> enableApplicationLayerAutomaticResponse(EnableApplicationLayerAutomaticResponseRequest enableApplicationLayerAutomaticResponseRequest)
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
This feature is available for Amazon CloudFront distributions and Application Load Balancers only.
This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation.
Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.
To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide.
enableApplicationLayerAutomaticResponseRequest - default CompletableFuture<EnableApplicationLayerAutomaticResponseResponse> enableApplicationLayerAutomaticResponse(Consumer<EnableApplicationLayerAutomaticResponseRequest.Builder> enableApplicationLayerAutomaticResponseRequest)
Enable the Shield Advanced automatic application layer DDoS mitigation for the protected resource.
This feature is available for Amazon CloudFront distributions and Application Load Balancers only.
This causes Shield Advanced to create, verify, and apply WAF rules for DDoS attacks that it detects for the resource. Shield Advanced applies the rules in a Shield rule group inside the web ACL that you've associated with the resource. For information about how automatic mitigation works and the requirements for using it, see Shield Advanced automatic application layer DDoS mitigation.
Don't use this action to make changes to automatic mitigation settings when it's already enabled for a resource. Instead, use UpdateApplicationLayerAutomaticResponse.
To use this feature, you must associate a web ACL with the protected resource. The web ACL must be created using the latest version of WAF (v2). You can associate the web ACL through the Shield Advanced console at https://console.aws.amazon.com/wafv2/shieldv2#/. For more information, see Getting Started with Shield Advanced. You can also associate the web ACL to the resource through the WAF console or the WAF API, but you must manage Shield Advanced automatic mitigation through Shield Advanced. For information about WAF, see WAF Developer Guide.
This is a convenience which creates an instance of the
EnableApplicationLayerAutomaticResponseRequest.Builder avoiding the need to create one manually via
EnableApplicationLayerAutomaticResponseRequest.builder()
enableApplicationLayerAutomaticResponseRequest - A Consumer that will call methods on
EnableApplicationLayerAutomaticResponseRequest.Builder to create a request.default CompletableFuture<EnableProactiveEngagementResponse> enableProactiveEngagement(EnableProactiveEngagementRequest enableProactiveEngagementRequest)
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
enableProactiveEngagementRequest - default CompletableFuture<EnableProactiveEngagementResponse> enableProactiveEngagement(Consumer<EnableProactiveEngagementRequest.Builder> enableProactiveEngagementRequest)
Authorizes the Shield Response Team (SRT) to use email and phone to notify contacts about escalations to the SRT and to initiate proactive customer support.
This is a convenience which creates an instance of the EnableProactiveEngagementRequest.Builder avoiding
the need to create one manually via EnableProactiveEngagementRequest.builder()
enableProactiveEngagementRequest - A Consumer that will call methods on EnableProactiveEngagementRequest.Builder to create a
request.default CompletableFuture<GetSubscriptionStateResponse> getSubscriptionState(GetSubscriptionStateRequest getSubscriptionStateRequest)
Returns the SubscriptionState, either Active or Inactive.
getSubscriptionStateRequest - default CompletableFuture<GetSubscriptionStateResponse> getSubscriptionState(Consumer<GetSubscriptionStateRequest.Builder> getSubscriptionStateRequest)
Returns the SubscriptionState, either Active or Inactive.
This is a convenience which creates an instance of the GetSubscriptionStateRequest.Builder avoiding the
need to create one manually via GetSubscriptionStateRequest.builder()
getSubscriptionStateRequest - A Consumer that will call methods on GetSubscriptionStateRequest.Builder to create a
request.default CompletableFuture<GetSubscriptionStateResponse> getSubscriptionState()
Returns the SubscriptionState, either Active or Inactive.
default CompletableFuture<ListAttacksResponse> listAttacks(ListAttacksRequest listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
listAttacksRequest - default CompletableFuture<ListAttacksResponse> listAttacks(Consumer<ListAttacksRequest.Builder> listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
This is a convenience which creates an instance of the ListAttacksRequest.Builder avoiding the need to
create one manually via ListAttacksRequest.builder()
listAttacksRequest - A Consumer that will call methods on ListAttacksRequest.Builder to create a request.default CompletableFuture<ListAttacksResponse> listAttacks()
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
default ListAttacksPublisher listAttacksPaginator()
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
This is a variant of listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListAttacksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListAttacksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest) operation.
default ListAttacksPublisher listAttacksPaginator(ListAttacksRequest listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
This is a variant of listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListAttacksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListAttacksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest) operation.
listAttacksRequest - default ListAttacksPublisher listAttacksPaginator(Consumer<ListAttacksRequest.Builder> listAttacksRequest)
Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.
This is a variant of listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListAttacksPublisher publisher = client.listAttacksPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListAttacksResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListAttacksResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttacks(software.amazon.awssdk.services.shield.model.ListAttacksRequest) operation.
This is a convenience which creates an instance of the ListAttacksRequest.Builder avoiding the need to
create one manually via ListAttacksRequest.builder()
listAttacksRequest - A Consumer that will call methods on ListAttacksRequest.Builder to create a request.default CompletableFuture<ListProtectionGroupsResponse> listProtectionGroups(ListProtectionGroupsRequest listProtectionGroupsRequest)
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
listProtectionGroupsRequest - NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default CompletableFuture<ListProtectionGroupsResponse> listProtectionGroups(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest)
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
This is a convenience which creates an instance of the ListProtectionGroupsRequest.Builder avoiding the
need to create one manually via ListProtectionGroupsRequest.builder()
listProtectionGroupsRequest - A Consumer that will call methods on ListProtectionGroupsRequest.Builder to create a
request.NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default ListProtectionGroupsPublisher listProtectionGroupsPaginator(ListProtectionGroupsRequest listProtectionGroupsRequest)
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
This is a variant of
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListProtectionGroupsPublisher publisher = client.listProtectionGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListProtectionGroupsPublisher publisher = client.listProtectionGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.
listProtectionGroupsRequest - NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default ListProtectionGroupsPublisher listProtectionGroupsPaginator(Consumer<ListProtectionGroupsRequest.Builder> listProtectionGroupsRequest)
Retrieves ProtectionGroup objects for the account. You can retrieve all protection groups or you can provide filtering criteria and retrieve just the subset of protection groups that match the criteria.
This is a variant of
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListProtectionGroupsPublisher publisher = client.listProtectionGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListProtectionGroupsPublisher publisher = client.listProtectionGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtectionGroups(software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest)
operation.
This is a convenience which creates an instance of the ListProtectionGroupsRequest.Builder avoiding the
need to create one manually via ListProtectionGroupsRequest.builder()
listProtectionGroupsRequest - A Consumer that will call methods on ListProtectionGroupsRequest.Builder to create a
request.NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default CompletableFuture<ListProtectionsResponse> listProtections(ListProtectionsRequest listProtectionsRequest)
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
listProtectionsRequest - NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default CompletableFuture<ListProtectionsResponse> listProtections(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest)
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
This is a convenience which creates an instance of the ListProtectionsRequest.Builder avoiding the need
to create one manually via ListProtectionsRequest.builder()
listProtectionsRequest - A Consumer that will call methods on ListProtectionsRequest.Builder to create a request.NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default CompletableFuture<ListProtectionsResponse> listProtections()
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default ListProtectionsPublisher listProtectionsPaginator()
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
This is a variant of
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest) operation.
NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default ListProtectionsPublisher listProtectionsPaginator(ListProtectionsRequest listProtectionsRequest)
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
This is a variant of
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest) operation.
listProtectionsRequest - NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default ListProtectionsPublisher listProtectionsPaginator(Consumer<ListProtectionsRequest.Builder> listProtectionsRequest)
Retrieves Protection objects for the account. You can retrieve all protections or you can provide filtering criteria and retrieve just the subset of protections that match the criteria.
This is a variant of
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListProtectionsPublisher publisher = client.listProtectionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListProtectionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListProtectionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listProtections(software.amazon.awssdk.services.shield.model.ListProtectionsRequest) operation.
This is a convenience which creates an instance of the ListProtectionsRequest.Builder avoiding the need
to create one manually via ListProtectionsRequest.builder()
listProtectionsRequest - A Consumer that will call methods on ListProtectionsRequest.Builder to create a request.NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default CompletableFuture<ListResourcesInProtectionGroupResponse> listResourcesInProtectionGroup(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest)
Retrieves the resources that are included in the protection group.
listResourcesInProtectionGroupRequest - NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default CompletableFuture<ListResourcesInProtectionGroupResponse> listResourcesInProtectionGroup(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest)
Retrieves the resources that are included in the protection group.
This is a convenience which creates an instance of the ListResourcesInProtectionGroupRequest.Builder
avoiding the need to create one manually via ListResourcesInProtectionGroupRequest.builder()
listResourcesInProtectionGroupRequest - A Consumer that will call methods on ListResourcesInProtectionGroupRequest.Builder to
create a request.NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default ListResourcesInProtectionGroupPublisher listResourcesInProtectionGroupPaginator(ListResourcesInProtectionGroupRequest listResourcesInProtectionGroupRequest)
Retrieves the resources that are included in the protection group.
This is a variant of
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupPublisher publisher = client.listResourcesInProtectionGroupPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupPublisher publisher = client.listResourcesInProtectionGroupPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.
listResourcesInProtectionGroupRequest - NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default ListResourcesInProtectionGroupPublisher listResourcesInProtectionGroupPaginator(Consumer<ListResourcesInProtectionGroupRequest.Builder> listResourcesInProtectionGroupRequest)
Retrieves the resources that are included in the protection group.
This is a variant of
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupPublisher publisher = client.listResourcesInProtectionGroupPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.shield.paginators.ListResourcesInProtectionGroupPublisher publisher = client.listResourcesInProtectionGroupPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourcesInProtectionGroup(software.amazon.awssdk.services.shield.model.ListResourcesInProtectionGroupRequest)
operation.
This is a convenience which creates an instance of the ListResourcesInProtectionGroupRequest.Builder
avoiding the need to create one manually via ListResourcesInProtectionGroupRequest.builder()
listResourcesInProtectionGroupRequest - A Consumer that will call methods on ListResourcesInProtectionGroupRequest.Builder to
create a request.NextToken specified in
the request is invalid. Submit the request using the NextToken value that was returned in
the prior response.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Gets information about Amazon Web Services tags for a specified Amazon Resource Name (ARN) in Shield.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds or updates tags for a resource in Shield.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds or updates tags for a resource in Shield.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a resource in Shield.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a resource in Shield.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateApplicationLayerAutomaticResponseResponse> updateApplicationLayerAutomaticResponse(UpdateApplicationLayerAutomaticResponseRequest updateApplicationLayerAutomaticResponseRequest)
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
updateApplicationLayerAutomaticResponseRequest - default CompletableFuture<UpdateApplicationLayerAutomaticResponseResponse> updateApplicationLayerAutomaticResponse(Consumer<UpdateApplicationLayerAutomaticResponseRequest.Builder> updateApplicationLayerAutomaticResponseRequest)
Updates an existing Shield Advanced automatic application layer DDoS mitigation configuration for the specified resource.
This is a convenience which creates an instance of the
UpdateApplicationLayerAutomaticResponseRequest.Builder avoiding the need to create one manually via
UpdateApplicationLayerAutomaticResponseRequest.builder()
updateApplicationLayerAutomaticResponseRequest - A Consumer that will call methods on
UpdateApplicationLayerAutomaticResponseRequest.Builder to create a request.default CompletableFuture<UpdateEmergencyContactSettingsResponse> updateEmergencyContactSettings(UpdateEmergencyContactSettingsRequest updateEmergencyContactSettingsRequest)
Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
updateEmergencyContactSettingsRequest - default CompletableFuture<UpdateEmergencyContactSettingsResponse> updateEmergencyContactSettings(Consumer<UpdateEmergencyContactSettingsRequest.Builder> updateEmergencyContactSettingsRequest)
Updates the details of the list of email addresses and phone numbers that the Shield Response Team (SRT) can use to contact you if you have proactive engagement enabled, for escalations to the SRT and to initiate proactive customer support.
This is a convenience which creates an instance of the UpdateEmergencyContactSettingsRequest.Builder
avoiding the need to create one manually via UpdateEmergencyContactSettingsRequest.builder()
updateEmergencyContactSettingsRequest - A Consumer that will call methods on UpdateEmergencyContactSettingsRequest.Builder to
create a request.default CompletableFuture<UpdateProtectionGroupResponse> updateProtectionGroup(UpdateProtectionGroupRequest updateProtectionGroupRequest)
Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
updateProtectionGroupRequest - default CompletableFuture<UpdateProtectionGroupResponse> updateProtectionGroup(Consumer<UpdateProtectionGroupRequest.Builder> updateProtectionGroupRequest)
Updates an existing protection group. A protection group is a grouping of protected resources so they can be handled as a collective. This resource grouping improves the accuracy of detection and reduces false positives.
This is a convenience which creates an instance of the UpdateProtectionGroupRequest.Builder avoiding the
need to create one manually via UpdateProtectionGroupRequest.builder()
updateProtectionGroupRequest - A Consumer that will call methods on UpdateProtectionGroupRequest.Builder to create a
request.default CompletableFuture<UpdateSubscriptionResponse> updateSubscription(UpdateSubscriptionRequest updateSubscriptionRequest)
Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
updateSubscriptionRequest - AutoRenew parameter during the last 30 days of your
subscription. This exception indicates that you are attempting to change AutoRenew prior to
that period.default CompletableFuture<UpdateSubscriptionResponse> updateSubscription(Consumer<UpdateSubscriptionRequest.Builder> updateSubscriptionRequest)
Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.
For accounts that are members of an Organizations organization, Shield Advanced subscriptions are billed against the organization's payer account, regardless of whether the payer account itself is subscribed.
This is a convenience which creates an instance of the UpdateSubscriptionRequest.Builder avoiding the
need to create one manually via UpdateSubscriptionRequest.builder()
updateSubscriptionRequest - A Consumer that will call methods on UpdateSubscriptionRequest.Builder to create a
request.AutoRenew parameter during the last 30 days of your
subscription. This exception indicates that you are attempting to change AutoRenew prior to
that period.default ShieldServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic ShieldAsyncClient create()
ShieldAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ShieldAsyncClientBuilder builder()
ShieldAsyncClient.Copyright © 2023. All rights reserved.