shield: AWS Shield

Description Usage Arguments Service syntax Operations Examples

View source: R/shield_service.R

Description

AWS Shield Advanced

This is the AWS Shield Advanced API Reference. This guide is for developers who need detailed information about the AWS Shield Advanced API actions, data types, and errors. For detailed information about AWS WAF and AWS Shield Advanced features and an overview of how to use the AWS WAF and AWS Shield Advanced APIs, see the AWS WAF and AWS Shield Developer Guide.

Usage

1
shield(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- shield(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

associate_drt_log_bucket Authorizes the DDoS Response team (DRT) to access the specified Amazon S3 bucket containing your AWS WAF logs
associate_drt_role Authorizes the DDoS Response team (DRT), using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks
create_protection Enables AWS Shield Advanced for a specific AWS resource
create_subscription Activates AWS Shield Advanced for an account
delete_protection Deletes an AWS Shield Advanced Protection
delete_subscription Removes AWS Shield Advanced from an account
describe_attack Describes the details of a DDoS attack
describe_drt_access 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
describe_emergency_contact_settings Lists the email addresses that the DRT can use to contact you during a suspected attack
describe_protection Lists the details of a Protection object
describe_subscription Provides details about the AWS Shield Advanced subscription for an account
disassociate_drt_log_bucket Removes the DDoS Response team's (DRT) access to the specified Amazon S3 bucket containing your AWS WAF logs
disassociate_drt_role Removes the DDoS Response team's (DRT) access to your AWS account
get_subscription_state Returns the SubscriptionState, either Active or Inactive
list_attacks Returns all ongoing DDoS attacks or all DDoS attacks during a specified time period
list_protections Lists all Protection objects for the account
update_emergency_contact_settings Updates the details of the list of email addresses that the DRT can use to contact you during a suspected attack
update_subscription Updates the details of an existing subscription

Examples

1
2
3
4
svc <- shield()
svc$associate_drt_log_bucket(
  Foo = 123
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.