1.204.0

class ResourcePolicy (construct)

LanguageType name
.NETAmazon.CDK.AWS.Logs.ResourcePolicy
Javasoftware.amazon.awscdk.services.logs.ResourcePolicy
Pythonaws_cdk.aws_logs.ResourcePolicy
TypeScript (source)@aws-cdk/aws-logs » ResourcePolicy

Implements IConstruct, IConstruct, IDependable, IResource

Resource Policy for CloudWatch Log Groups.

Policies define the operations that are allowed on this resource.

You almost never need to define this construct directly.

All AWS resources that support resource policies have a method called addToResourcePolicy(), which will automatically create a new resource policy if one doesn't exist yet, otherwise it will add to the existing policy.

Prefer to use addToResourcePolicy() instead.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as iam from '@aws-cdk/aws-iam';
import * as logs from '@aws-cdk/aws-logs';

declare const policyStatement: iam.PolicyStatement;
const resourcePolicy = new logs.ResourcePolicy(this, 'MyResourcePolicy', /* all optional props */ {
  policyStatements: [policyStatement],
  resourcePolicyName: 'resourcePolicyName',
});

Initializer

new ResourcePolicy(scope: Construct, id: string, props?: ResourcePolicyProps)

Parameters

Construct Props

NameTypeDescription
policyStatements?PolicyStatement[]Initial statements to add to the resource policy.
resourcePolicyName?stringName of the log group resource policy.

policyStatements?

Type: PolicyStatement[] (optional, default: No statements)

Initial statements to add to the resource policy.

resourcePolicyName?

Type: string (optional, default: Uses a unique id based on the construct path)

Name of the log group resource policy.

Properties

NameTypeDescription
documentPolicyDocumentThe IAM policy document for this resource policy.
envResourceEnvironmentThe environment this resource belongs to.
nodeConstructNodeThe construct tree node associated with this construct.
stackStackThe stack in which this resource is defined.

document

Type: PolicyDocument

The IAM policy document for this resource policy.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node

Type: ConstructNode

The construct tree node associated with this construct.

stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.

← PreviousNext →