UntrustedCodeBoundaryPolicy

class aws_cdk.aws_codebuild.UntrustedCodeBoundaryPolicy(scope, id, *, additional_statements=None, managed_policy_name=None)

Bases: ManagedPolicy

Permissions Boundary for a CodeBuild Project running untrusted code.

This class is a Policy, intended to be used as a Permissions Boundary for a CodeBuild project. It allows most of the actions necessary to run the CodeBuild project, but disallows reading from Parameter Store and Secrets Manager.

Use this when your CodeBuild project is running untrusted code (for example, if you are using one to automatically build Pull Requests that anyone can submit), and you want to prevent your future self from accidentally exposing Secrets to this build.

(The reason you might want to do this is because otherwise anyone who can submit a Pull Request to your project can write a script to email those secrets to themselves).

Example:

# project: codebuild.Project

iam.PermissionsBoundary.of(project).apply(codebuild.UntrustedCodeBoundaryPolicy(self, "Boundary"))
Parameters:

  • scope (Construct) –

  • id (str) –

  • additional_statements (Optional[Sequence[PolicyStatement]]) – Additional statements to add to the default set of statements. Default: - No additional statements

  • managed_policy_name (Optional[str]) – The name of the managed policy. Default: - A name is automatically generated.

Methods

add_statements(*statement)

Adds a statement to the policy document.

Parameters:

statement (PolicyStatement) –

Return type:

None

apply_removal_policy(policy)

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).

Parameters:

policy (RemovalPolicy) –

Return type:

None

attach_to_group(group)

Attaches this policy to a group.

Parameters:

group (IGroup) –

Return type:

None

attach_to_role(role)

Attaches this policy to a role.

Parameters:

role (IRole) –

Return type:

None

attach_to_user(user)

Attaches this policy to a user.

Parameters:

user (IUser) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:

str

Attributes

description

The description of this policy.

Attribute:

true

document

The policy document.

env

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.

grant_principal

The principal to grant permissions to.

managed_policy_arn

Returns the ARN of this managed policy.

Attribute:

true

managed_policy_name

The name of this policy.

Attribute:

true

node

The tree node.

path

The path of this policy.

Attribute:

true

stack

The stack in which this resource is defined.

Static Methods

classmethod from_aws_managed_policy_name(managed_policy_name)

Import a managed policy from one of the policies that AWS manages.

For this managed policy, you only need to know the name to be able to use it.

Some managed policy names start with “service-role/”, some start with “job-function/”, and some don’t start with anything. Include the prefix when constructing this object.

Parameters:

managed_policy_name (str) –

Return type:

IManagedPolicy

classmethod from_managed_policy_arn(scope, id, managed_policy_arn)

Import an external managed policy by ARN.

For this managed policy, you only need to know the ARN to be able to use it. This can be useful if you got the ARN from a CloudFormation Export.

If the imported Managed Policy ARN is a Token (such as a CfnParameter.valueAsString or a Fn.importValue()) and the referenced managed policy has a path (like arn:...:policy/AdminPolicy/AdminAllow), the managedPolicyName property will not resolve to the correct value. Instead it will resolve to the first path component. We unfortunately cannot express the correct calculation of the full path name as a CloudFormation expression. In this scenario the Managed Policy ARN should be supplied without the path in order to resolve the correct managed policy resource.

Parameters:

  • scope (Construct) – construct scope.

  • id (str) – construct id.

  • managed_policy_arn (str) – the ARN of the managed policy to import.

Return type:

IManagedPolicy

classmethod from_managed_policy_name(scope, id, managed_policy_name)

Import a customer managed policy from the managedPolicyName.

For this managed policy, you only need to know the name to be able to use it.

Parameters:

  • scope (Construct) –

  • id (str) –

  • managed_policy_name (str) –

Return type:

IManagedPolicy

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool