ShieldClient

Struct ShieldClient 

Source
pub struct ShieldClient { /* private fields */ }
Expand description

A client for the AWS Shield API.

Implementations§

Source§

impl ShieldClient

Source

pub fn new(region: Region) -> ShieldClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

Source

pub fn new_with<P, D>( request_dispatcher: D, credentials_provider: P, region: Region, ) -> ShieldClient
where P: ProvideAwsCredentials + Send + Sync + 'static, D: DispatchSignedRequest + Send + Sync + 'static,

Source

pub fn new_with_client(client: Client, region: Region) -> ShieldClient

Trait Implementations§

Source§

impl Clone for ShieldClient

Source§

fn clone(&self) -> ShieldClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Shield for ShieldClient

Source§

fn associate_drt_log_bucket<'life0, 'async_trait>( &'life0 self, input: AssociateDRTLogBucketRequest, ) -> Pin<Box<dyn Future<Output = Result<AssociateDRTLogBucketResponse, RusotoError<AssociateDRTLogBucketError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Authorizes the DDoS Response Team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs. You can associate up to 10 Amazon S3 buckets with your subscription.

To use the services of the DRT and make an AssociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

Source§

fn associate_drt_role<'life0, 'async_trait>( &'life0 self, input: AssociateDRTRoleRequest, ) -> Pin<Box<dyn Future<Output = Result<AssociateDRTRoleResponse, RusotoError<AssociateDRTRoleError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Authorizes the DDoS Response Team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. This enables the DRT to inspect your AWS WAF configuration and create or update AWS 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 you will specify in the request. For more information see Attaching and Detaching IAM Policies. The role must also trust the service principal drt.shield.amazonaws.com. For more information, see IAM JSON Policy Elements: Principal.

The DRT will have access only to your AWS WAF and Shield resources. By submitting this request, you authorize the DRT to inspect your AWS WAF and Shield configuration and create and update AWS WAF rules and web ACLs on your behalf. The DRT 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 AWS Service.

To use the services of the DRT and make an AssociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan.

Source§

fn associate_health_check<'life0, 'async_trait>( &'life0 self, input: AssociateHealthCheckRequest, ) -> Pin<Box<dyn Future<Output = Result<AssociateHealthCheckResponse, RusotoError<AssociateHealthCheckError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Adds health-based detection to the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.

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 AWS WAF and AWS Shield Developer Guide.

Source§

fn associate_proactive_engagement_details<'life0, 'async_trait>( &'life0 self, input: AssociateProactiveEngagementDetailsRequest, ) -> Pin<Box<dyn Future<Output = Result<AssociateProactiveEngagementDetailsResponse, RusotoError<AssociateProactiveEngagementDetailsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Initializes proactive engagement and sets the list of contacts for the DDoS Response Team (DRT) 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 DDoS Response Team (DRT) can use to contact you for escalations to the DRT 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.

Source§

fn create_protection<'life0, 'async_trait>( &'life0 self, input: CreateProtectionRequest, ) -> Pin<Box<dyn Future<Output = Result<CreateProtectionResponse, RusotoError<CreateProtectionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Enables AWS Shield Advanced for a specific AWS resource. The resource can be an Amazon CloudFront distribution, Elastic Load Balancing load balancer, AWS Global Accelerator accelerator, Elastic IP Address, or an Amazon Route 53 hosted zone.

You can add protection to only a single resource with each CreateProtection request. If you want to add protection to multiple resources at once, use the AWS WAF console. For more information see Getting Started with AWS Shield Advanced and Add AWS Shield Advanced Protection to more AWS Resources.

Source§

fn create_subscription<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CreateSubscriptionResponse, RusotoError<CreateSubscriptionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Activates AWS Shield Advanced for an account.

When you initally 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.

Source§

fn delete_protection<'life0, 'async_trait>( &'life0 self, input: DeleteProtectionRequest, ) -> Pin<Box<dyn Future<Output = Result<DeleteProtectionResponse, RusotoError<DeleteProtectionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Deletes an AWS Shield Advanced Protection.

Source§

fn delete_subscription<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DeleteSubscriptionResponse, RusotoError<DeleteSubscriptionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Removes AWS Shield Advanced from an account. AWS Shield Advanced requires a 1-year subscription commitment. You cannot delete a subscription prior to the completion of that commitment.

Source§

fn describe_attack<'life0, 'async_trait>( &'life0 self, input: DescribeAttackRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeAttackResponse, RusotoError<DescribeAttackError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Describes the details of a DDoS attack.

Source§

fn describe_drt_access<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DescribeDRTAccessResponse, RusotoError<DescribeDRTAccessError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the current role and list of Amazon S3 log buckets used by the DDoS Response Team (DRT) to access your AWS account while assisting with attack mitigation.

Source§

fn describe_emergency_contact_settings<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DescribeEmergencyContactSettingsResponse, RusotoError<DescribeEmergencyContactSettingsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

A list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

Source§

fn describe_protection<'life0, 'async_trait>( &'life0 self, input: DescribeProtectionRequest, ) -> Pin<Box<dyn Future<Output = Result<DescribeProtectionResponse, RusotoError<DescribeProtectionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Lists the details of a Protection object.

Source§

fn describe_subscription<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DescribeSubscriptionResponse, RusotoError<DescribeSubscriptionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Provides details about the AWS Shield Advanced subscription for an account.

Source§

fn disable_proactive_engagement<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DisableProactiveEngagementResponse, RusotoError<DisableProactiveEngagementError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Removes authorization from the DDoS Response Team (DRT) to notify contacts about escalations to the DRT and to initiate proactive customer support.

Source§

fn disassociate_drt_log_bucket<'life0, 'async_trait>( &'life0 self, input: DisassociateDRTLogBucketRequest, ) -> Pin<Box<dyn Future<Output = Result<DisassociateDRTLogBucketResponse, RusotoError<DisassociateDRTLogBucketError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Removes the DDoS Response Team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs.

To make a DisassociateDRTLogBucket request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTLogBucket request to remove this access.

Source§

fn disassociate_drt_role<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DisassociateDRTRoleResponse, RusotoError<DisassociateDRTRoleError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Removes the DDoS Response Team's (DRT) access to your AWS account.

To make a DisassociateDRTRole request, you must be subscribed to the Business Support plan or the Enterprise Support plan. However, if you are not subscribed to one of these support plans, but had been previously and had granted the DRT access to your account, you can submit a DisassociateDRTRole request to remove this access.

Source§

fn disassociate_health_check<'life0, 'async_trait>( &'life0 self, input: DisassociateHealthCheckRequest, ) -> Pin<Box<dyn Future<Output = Result<DisassociateHealthCheckResponse, RusotoError<DisassociateHealthCheckError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Removes health-based detection from the Shield Advanced protection for a resource. Shield Advanced health-based detection uses the health of your AWS resource to improve responsiveness and accuracy in attack detection and mitigation.

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 AWS WAF and AWS Shield Developer Guide.

Source§

fn enable_proactive_engagement<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<EnableProactiveEngagementResponse, RusotoError<EnableProactiveEngagementError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Authorizes the DDoS Response Team (DRT) to use email and phone to notify contacts about escalations to the DRT and to initiate proactive customer support.

Source§

fn get_subscription_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<GetSubscriptionStateResponse, RusotoError<GetSubscriptionStateError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns the SubscriptionState, either Active or Inactive.

Source§

fn list_attacks<'life0, 'async_trait>( &'life0 self, input: ListAttacksRequest, ) -> Pin<Box<dyn Future<Output = Result<ListAttacksResponse, RusotoError<ListAttacksError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period.

Source§

fn list_protections<'life0, 'async_trait>( &'life0 self, input: ListProtectionsRequest, ) -> Pin<Box<dyn Future<Output = Result<ListProtectionsResponse, RusotoError<ListProtectionsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Lists all Protection objects for the account.

Source§

fn update_emergency_contact_settings<'life0, 'async_trait>( &'life0 self, input: UpdateEmergencyContactSettingsRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateEmergencyContactSettingsResponse, RusotoError<UpdateEmergencyContactSettingsError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Updates the details of the list of email addresses and phone numbers that the DDoS Response Team (DRT) can use to contact you if you have proactive engagement enabled, for escalations to the DRT and to initiate proactive customer support.

Source§

fn update_subscription<'life0, 'async_trait>( &'life0 self, input: UpdateSubscriptionRequest, ) -> Pin<Box<dyn Future<Output = Result<UpdateSubscriptionResponse, RusotoError<UpdateSubscriptionError>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Updates the details of an existing subscription. Only enter values for parameters you want to change. Empty parameters are not updated.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more