AWS Native v0.103.0, Apr 22 24

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

aws-native.shield.getProtectionGroup

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

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

ProtectionGroupArn string

The ARN (Amazon Resource Name) of the protection group.

ResourceType ProtectionGroupResourceType

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

protectionGroupArn String

The ARN (Amazon Resource Name) of the protection group.

resourceType ProtectionGroupResourceType

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

protectionGroupArn string

The ARN (Amazon Resource Name) of the protection group.

resourceType ProtectionGroupResourceType

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

protection_group_arn str

The ARN (Amazon Resource Name) of the protection group.

resource_type ProtectionGroupResourceType

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"

protectionGroupArn String