Class CfnDRTAccess
A CloudFormation AWS::Shield::DRTAccess
.
Inherited Members
Namespace: Amazon.CDK.AWS.Shield
Assembly: Amazon.CDK.AWS.Shield.dll
Syntax (csharp)
public class CfnDRTAccess : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDRTAccess
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Provides permissions for the AWS Shield Advanced Shield response team (SRT) to access your account and your resource protections, to help you mitigate potential distributed denial of service (DDoS) attacks.
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::DRTAccess
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-shield-drtaccess.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 cfnDRTAccess = new CfnDRTAccess(this, "MyCfnDRTAccess", new CfnDRTAccessProps {
RoleArn = "roleArn",
// the properties below are optional
LogBucketList = new [] { "logBucketList" }
});
Synopsis
Constructors
CfnDRTAccess(Construct, String, ICfnDRTAccessProps) | Create a new |
CfnDRTAccess(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDRTAccess(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrAccountId | The ID of the account that submitted the template. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
LogBucketList | Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources. |
RoleArn | Authorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDRTAccess(Construct, String, ICfnDRTAccessProps)
Create a new AWS::Shield::DRTAccess
.
public CfnDRTAccess(Construct scope, string id, ICfnDRTAccessProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDRTAccessProps
- resource properties.
CfnDRTAccess(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDRTAccess(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDRTAccess(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDRTAccess(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrAccountId
The ID of the account that submitted the template.
public virtual string AttrAccountId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AccountId
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
LogBucketList
Authorizes the Shield Response Team (SRT) to access the specified Amazon S3 bucket containing log data such as Application Load Balancer access logs, CloudFront logs, or logs from third party sources.
public virtual string[] LogBucketList { get; set; }
Property Value
System.String[]
Remarks
You can associate up to 10 Amazon S3 buckets with your subscription.
Use this to share information with the SRT that's not available in AWS WAF logs.
To use the services of the SRT, you must be subscribed to the Business Support plan or the Enterprise Support plan .
RoleArn
Authorizes the Shield Response Team (SRT) using the specified role, to access your AWS account to assist with DDoS attack mitigation during potential attacks.
public virtual string RoleArn { get; set; }
Property Value
System.String
Remarks
This enables the SRT to inspect your AWS WAF configuration and logs and to create or update AWS WAF rules and web ACLs.
You can associate only one RoleArn
with your subscription. If you submit this update for an account that already has an associated role, the new RoleArn
will replace the existing RoleArn
.
This change requires the following:
The SRT will have access only to your AWS WAF and Shield resources. By submitting this request, you provide permissions to the SRT to inspect your AWS WAF and Shield configuration and logs, and to create and update AWS WAF rules and web ACLs on your behalf. The SRT takes these actions only if explicitly authorized by you.
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>