Class: Aws::Shield::Types::CreateProtectionGroupRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb

Overview

Note:

When making an API call, you may pass CreateProtectionGroupRequest data as a hash:

{
  protection_group_id: "ProtectionGroupId", # required
  aggregation: "SUM", # required, accepts SUM, MEAN, MAX
  pattern: "ALL", # required, accepts ALL, ARBITRARY, BY_RESOURCE_TYPE
  resource_type: "CLOUDFRONT_DISTRIBUTION", # accepts CLOUDFRONT_DISTRIBUTION, ROUTE_53_HOSTED_ZONE, ELASTIC_IP_ALLOCATION, CLASSIC_LOAD_BALANCER, APPLICATION_LOAD_BALANCER, GLOBAL_ACCELERATOR
  members: ["ResourceArn"],
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aggregationString

Defines how Shield combines resource data for the group in order to detect, mitigate, and report events.

  • Sum - Use the total traffic across the group. This is a good choice for most cases. Examples include Elastic IP addresses for EC2 instances that scale manually or automatically.

  • Mean - Use the average of the traffic across the group. This is a good choice for resources that share traffic uniformly. Examples include accelerators and load balancers.

  • Max - Use the highest traffic from each resource. This is useful for resources that don't share traffic and for resources that share that traffic in a non-uniform way. Examples include Amazon CloudFront and origin resources for CloudFront distributions.

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 590

class CreateProtectionGroupRequest < Struct.new(
  :protection_group_id,
  :aggregation,
  :pattern,
  :resource_type,
  :members,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#membersArray<String>

The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

Returns:

  • (Array<String>)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 590

class CreateProtectionGroupRequest < Struct.new(
  :protection_group_id,
  :aggregation,
  :pattern,
  :resource_type,
  :members,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#patternString

The criteria to use to choose the protected resources for inclusion in the group. You can include all resources that have protections, provide a list of resource Amazon Resource Names (ARNs), or include all resources of a specified resource type.

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 590

class CreateProtectionGroupRequest < Struct.new(
  :protection_group_id,
  :aggregation,
  :pattern,
  :resource_type,
  :members,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#protection_group_idString

The name of the protection group. You use this to identify the protection group in lists and to manage the protection group, for example to update, delete, or describe it.

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 590

class CreateProtectionGroupRequest < Struct.new(
  :protection_group_id,
  :aggregation,
  :pattern,
  :resource_type,
  :members,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_typeString

The resource type to include in the protection group. All protected resources of this type are included in the protection group. Newly protected resources of this type are automatically added to the group. You must set this when you set Pattern to BY_RESOURCE_TYPE and you must not set it for any other Pattern setting.

Returns:

  • (String)


590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 590

class CreateProtectionGroupRequest < Struct.new(
  :protection_group_id,
  :aggregation,
  :pattern,
  :resource_type,
  :members,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

One or more tag key-value pairs for the protection group.

Returns:



590
591
592
593
594
595
596
597
598
599
# File 'gems/aws-sdk-shield/lib/aws-sdk-shield/types.rb', line 590

class CreateProtectionGroupRequest < Struct.new(
  :protection_group_id,
  :aggregation,
  :pattern,
  :resource_type,
  :members,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end