Show / Hide Table of Contents

Class CfnResourcePolicy

A CloudFormation AWS::CloudTrail::ResourcePolicy.

Inheritance
System.Object
Construct
CfnElement
CfnRefElement
CfnResource
CfnResourcePolicy
Implements
IConstruct
Constructs.IConstruct
IDependable
IInspectable
Inherited Members
CfnResource.IsCfnResource(IConstruct)
CfnResource.AddDeletionOverride(String)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(String, Object)
CfnResource.AddOverride(String, Object)
CfnResource.AddPropertyDeletionOverride(String)
CfnResource.AddPropertyOverride(String, Object)
CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String)
CfnResource.GetMetadata(String)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(Object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.UpdatedProperites
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK.AWS.CloudTrail
Assembly: Amazon.CDK.AWS.CloudTrail.dll
Syntax (csharp)
public class CfnResourcePolicy : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnResourcePolicy
    Inherits CfnResource
    Implements IConstruct, IDependable, IInspectable
Remarks

Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of AWS . For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide .

CloudformationResource: AWS::CloudTrail::ResourcePolicy

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.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.CloudTrail;

var resourcePolicy;

var cfnResourcePolicy = new CfnResourcePolicy(this, "MyCfnResourcePolicy", new CfnResourcePolicyProps {
    ResourceArn = "resourceArn",
    ResourcePolicy = resourcePolicy
});

Synopsis

Constructors

CfnResourcePolicy(Construct, String, ICfnResourcePolicyProps)

Create a new AWS::CloudTrail::ResourcePolicy.

CfnResourcePolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnResourcePolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CfnProperties
ResourceArn

The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.

ResourcePolicy

A JSON-formatted string for an AWS resource-based policy.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

Constructors

CfnResourcePolicy(Construct, String, ICfnResourcePolicyProps)

Create a new AWS::CloudTrail::ResourcePolicy.

public CfnResourcePolicy(Construct scope, string id, ICfnResourcePolicyProps props)
Parameters
scope Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnResourcePolicyProps
  • resource properties.

CfnResourcePolicy(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnResourcePolicy(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnResourcePolicy(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnResourcePolicy(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

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
CfnResource.CfnProperties

ResourceArn

The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy.

public virtual string ResourceArn { get; set; }
Property Value

System.String

Remarks

The following is the format of a resource ARN: arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html#cfn-cloudtrail-resourcepolicy-resourcearn

ResourcePolicy

A JSON-formatted string for an AWS resource-based policy.

public virtual object ResourcePolicy { get; set; }
Property Value

System.Object

Remarks

The following are requirements for the resource policy:

    Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-resourcepolicy.html#cfn-cloudtrail-resourcepolicy-resourcepolicy

    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>

    Overrides
    CfnResource.RenderProperties(IDictionary<String, Object>)

    Implements

    IConstruct
    Constructs.IConstruct
    IDependable
    IInspectable
    Back to top Generated by DocFX