Class CfnProtectionGroup
A CloudFormation AWS::Shield::ProtectionGroup
.
Inherited Members
Namespace: Amazon.CDK.AWS.Shield
Assembly: Amazon.CDK.AWS.Shield.dll
Syntax (csharp)
public class CfnProtectionGroup : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnProtectionGroup
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Creates 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.
To configure this resource through AWS CloudFormation , you must be subscribed to AWS Shield Advanced . You can subscribe through the Shield Advanced console and through the APIs. For more information, see Subscribe to AWS Shield Advanced .
See example templates for Shield Advanced in AWS CloudFormation at aws-samples/aws-shield-advanced-examples .
CloudformationResource: AWS::Shield::ProtectionGroup
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 cfnProtectionGroup = new CfnProtectionGroup(this, "MyCfnProtectionGroup", 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
Constructors
CfnProtectionGroup(Construct, String, ICfnProtectionGroupProps) | Create a new |
CfnProtectionGroup(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnProtectionGroup(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
Aggregation | Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events. |
AttrProtectionGroupArn | The ARN (Amazon Resource Name) of the new protection group. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnProtectionGroup(Construct, String, ICfnProtectionGroupProps)
Create a new AWS::Shield::ProtectionGroup
.
public CfnProtectionGroup(Construct scope, string id, ICfnProtectionGroupProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnProtectionGroupProps
- resource properties.
CfnProtectionGroup(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnProtectionGroup(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnProtectionGroup(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnProtectionGroup(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Aggregation
Defines how AWS Shield combines resource data for the group in order to detect, mitigate, and report events.
public virtual string Aggregation { get; set; }
Property Value
System.String
Remarks
AttrProtectionGroupArn
The ARN (Amazon Resource Name) of the new protection group.
public virtual string AttrProtectionGroupArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ProtectionGroupArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Members
The ARNs (Amazon Resource Names) of the resources to include in the protection group.
public virtual string[] Members { get; set; }
Property Value
System.String[]
Remarks
You must set this when you set Pattern
to ARBITRARY
and you must not set it for any other Pattern
setting.
Pattern
The criteria to use to choose the protected resources for inclusion in the group.
public virtual string Pattern { get; set; }
Property Value
System.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.
ProtectionGroupId
The name of the protection group.
public virtual string ProtectionGroupId { get; set; }
Property Value
System.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.
ResourceType
The resource type to include in the protection group.
public virtual string ResourceType { get; set; }
Property Value
System.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.
Tags
Key:value pairs associated with an AWS resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
To modify tags on existing resources, use the AWS Shield Advanced APIs or command line interface. With AWS CloudFormation , you can only add tags to resources during resource creation.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>