Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. shield
  5. getProtectionGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.shield.getProtectionGroup

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.

    Using getProtectionGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getProtectionGroup(args: GetProtectionGroupArgs, opts?: InvokeOptions): Promise<GetProtectionGroupResult>
function getProtectionGroupOutput(args: GetProtectionGroupOutputArgs, opts?: InvokeOptions): Output<GetProtectionGroupResult>
    def get_protection_group(protection_group_arn: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetProtectionGroupResult
def get_protection_group_output(protection_group_arn: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetProtectionGroupResult]
    func LookupProtectionGroup(ctx *Context, args *LookupProtectionGroupArgs, opts ...InvokeOption) (*LookupProtectionGroupResult, error)
func LookupProtectionGroupOutput(ctx *Context, args *LookupProtectionGroupOutputArgs, opts ...InvokeOption) LookupProtectionGroupResultOutput

    > Note: This function is named LookupProtectionGroup in the Go SDK.

    public static class GetProtectionGroup 
{
    public static Task<GetProtectionGroupResult> InvokeAsync(GetProtectionGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetProtectionGroupResult> Invoke(GetProtectionGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProtectionGroupResult> getProtectionGroup(GetProtectionGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:shield:getProtectionGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ProtectionGroupArn string
    The ARN (Amazon Resource Name) of the protection group.
    ProtectionGroupArn string
    The ARN (Amazon Resource Name) of the protection group.
    protectionGroupArn String
    The ARN (Amazon Resource Name) of the protection group.
    protectionGroupArn string
    The ARN (Amazon Resource Name) of the protection group.
    protection_group_arn str
    The ARN (Amazon Resource Name) of the protection group.
    protectionGroupArn String
    The ARN (Amazon Resource Name) of the protection group.

    getProtectionGroup Result

    The following output properties are available:

    Aggregation Pulumi.AwsNative.Shield.ProtectionGroupAggregation
    Defines how AWS 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.
    Members List<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.
    Pattern Pulumi.AwsNative.Shield.ProtectionGroupPattern
    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.
    ProtectionGroupArn string
    The ARN (Amazon Resource Name) of the protection group.
    ResourceType Pulumi.AwsNative.Shield.ProtectionGroupResourceType
    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.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    One or more tag key-value pairs for the Protection object.
    Aggregation ProtectionGroupAggregation
    Defines how AWS 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.
    Members []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.
    Pattern ProtectionGroupPattern
    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.
    ProtectionGroupArn string
    The ARN (Amazon Resource Name) of the protection group.
    ResourceType ProtectionGroupResourceType
    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.
    Tags Tag
    One or more tag key-value pairs for the Protection object.
    aggregation ProtectionGroupAggregation
    Defines how AWS 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.
    members List<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.
    pattern ProtectionGroupPattern
    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.
    protectionGroupArn String
    The ARN (Amazon Resource Name) of the protection group.
    resourceType ProtectionGroupResourceType
    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.
    tags List<Tag>
    One or more tag key-value pairs for the Protection object.
    aggregation ProtectionGroupAggregation
    Defines how AWS 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.
    members 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.
    pattern ProtectionGroupPattern
    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.
    protectionGroupArn string
    The ARN (Amazon Resource Name) of the protection group.
    resourceType ProtectionGroupResourceType
    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.
    tags Tag[]
    One or more tag key-value pairs for the Protection object.
    aggregation ProtectionGroupAggregation
    Defines how AWS 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.
    members Sequence[str]
    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.
    pattern ProtectionGroupPattern
    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.
    protection_group_arn str
    The ARN (Amazon Resource Name) of the protection group.
    resource_type ProtectionGroupResourceType
    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.
    tags Sequence[root_Tag]
    One or more tag key-value pairs for the Protection object.
    aggregation "SUM" | "MEAN" | "MAX"
    Defines how AWS 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.
    members List<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.
    pattern "ALL" | "ARBITRARY" | "BY_RESOURCE_TYPE"
    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.
    protectionGroupArn String
    The ARN (Amazon Resource Name) of the protection group.
    resourceType "CLOUDFRONT_DISTRIBUTION" | "ROUTE_53_HOSTED_ZONE" | "ELASTIC_IP_ALLOCATION" | "CLASSIC_LOAD_BALANCER" | "APPLICATION_LOAD_BALANCER" | "GLOBAL_ACCELERATOR"
    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.
    tags List<Property Map>
    One or more tag key-value pairs for the Protection object.

    Supporting Types

    ProtectionGroupAggregation

    ProtectionGroupPattern

    ProtectionGroupResourceType

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native