Interface ICfnProtectionGroupProps

Properties for defining a CfnProtectionGroup.

Namespace: Amazon.CDK.AWS.Shield

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnProtectionGroupProps

Syntax (vb)

Public Interface ICfnProtectionGroupProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Shield;

             var cfnProtectionGroupProps = new CfnProtectionGroupProps {
                 Aggregation = "aggregation",
                 Pattern = "pattern",
                 ProtectionGroupId = "protectionGroupId",

                 // the properties below are optional
                 Members = new [] { "members" },
                 ResourceType = "resourceType",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

Aggregation	Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
Members	The ARNs (Amazon Resource Names) of the resources to include in the protection group.
Pattern	The criteria to use to choose the protected resources for inclusion in the group.
ProtectionGroupId	The name of the protection group.
ResourceType	The resource type to include in the protection group.
Tags	Key:value pairs associated with an AWS resource.

Properties

Aggregation

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

string Aggregation { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-aggregation

Members

The ARNs (Amazon Resource Names) of the resources to include in the protection group.

string[]? Members { get; }

Property Value

string[]

Remarks

You must set this when you set Pattern to ARBITRARY and you must not set it for any other Pattern setting.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-members

Pattern

The criteria to use to choose the protected resources for inclusion in the group.

string Pattern { get; }

Property Value

string

Remarks

You can include all resources that have protections, provide a list of resource ARNs (Amazon Resource Names), or include all resources of a specified resource type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-pattern

ProtectionGroupId

The name of the protection group.

string ProtectionGroupId { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-protectiongroupid

ResourceType

The resource type to include in the protection group.

string? ResourceType { get; }

Property Value

string

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-protectiongroup.html#cfn-shield-protectiongroup-resourcetype