CfnPolicy

class aws_cdk.aws_verifiedpermissions.CfnPolicy(scope, id, *, definition, policy_store_id)

Bases: CfnResource

Creates or updates a Cedar policy and saves it in the specified policy store.

You can create either a static policy or a policy linked to a policy template.

You can directly update only static policies. To update a template-linked policy, you must update it’s linked policy template instead.

To create a static policy, in the Definition include a Static element that includes the Cedar policy text in the Statement element.
To create a policy that is dynamically linked to a policy template, in the Definition include a Templatelinked element that specifies the policy template ID and the principal and resource to associate with this policy. If the policy template is ever updated, any policies linked to the policy template automatically use the updated template.

If policy validation is enabled in the policy store, then updating a static policy causes Verified Permissions to validate the policy against the schema in the policy store. If the updated static policy doesn’t pass validation, the operation fails and the update isn’t stored.

When you edit a static policy, You can change only certain elements of a static policy:

The action referenced by the policy.

A condition clause, such as when and unless.

You can’t change these elements of a static policy:

Changing a policy from a static policy to a template-linked policy.

Changing the effect of a static policy from permit or forbid.

The principal referenced by a static policy.

The resource referenced by a static policy.

To update a template-linked policy, you must update the template instead.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policy.html
CloudformationResource:: AWS::VerifiedPermissions::Policy
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

cfn_policy = verifiedpermissions.CfnPolicy(self, "MyCfnPolicy",
    definition=verifiedpermissions.CfnPolicy.PolicyDefinitionProperty(
        static=verifiedpermissions.CfnPolicy.StaticPolicyDefinitionProperty(
            statement="statement",

            # the properties below are optional
            description="description"
        ),
        template_linked=verifiedpermissions.CfnPolicy.TemplateLinkedPolicyDefinitionProperty(
            policy_template_id="policyTemplateId",

            # the properties below are optional
            principal=verifiedpermissions.CfnPolicy.EntityIdentifierProperty(
                entity_id="entityId",
                entity_type="entityType"
            ),
            resource=verifiedpermissions.CfnPolicy.EntityIdentifierProperty(
                entity_id="entityId",
                entity_type="entityType"
            )
        )
    ),
    policy_store_id="policyStoreId"
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
definition (Union[IResolvable, PolicyDefinitionProperty, Dict[str, Any]]) – Specifies the policy type and content to use for the new or updated policy. The definition structure must include either a Static or a TemplateLinked element.
policy_store_id (str) – Specifies the PolicyStoreId of the policy store you want to store the policy in.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::VerifiedPermissions::Policy'

attr_policy_id

The unique ID of the new or updated policy.

CloudformationAttribute:: PolicyId

attr_policy_type

.

Static
TemplateLinked

CloudformationAttribute:: PolicyType
Type:: The type of the policy. This is one of the following values

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

definition: Specifies the policy type and content to use for the new or updated policy.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node: The tree node.

policy_store_id: Specifies the PolicyStoreId of the policy store you want to store the policy in.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

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.

EntityIdentifierProperty

class CfnPolicy.EntityIdentifierProperty(*, entity_id, entity_type)

Bases: object

Contains the identifier of an entity in a policy, including its ID and type.

Parameters:

entity_id (str) – The identifier of an entity. "entityId":" *identifier* "
entity_type (str) – The type of an entity. Example: "entityType":" *typeName* "

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-entityidentifier.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

entity_identifier_property = verifiedpermissions.CfnPolicy.EntityIdentifierProperty(
    entity_id="entityId",
    entity_type="entityType"
)

Attributes

entity_id

The identifier of an entity.

"entityId":" *identifier* "

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-entityidentifier.html#cfn-verifiedpermissions-policy-entityidentifier-entityid

entity_type

The type of an entity.

Example: "entityType":" *typeName* "

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-entityidentifier.html#cfn-verifiedpermissions-policy-entityidentifier-entitytype

PolicyDefinitionProperty

class CfnPolicy.PolicyDefinitionProperty(*, static=None, template_linked=None)

Bases: object

A structure that defines a Cedar policy.

It includes the policy type, a description, and a policy body. This is a top level data type used to create a policy.

This data type is used as a request parameter for the CreatePolicy operation. This structure must always have either an Static or a TemplateLinked element.

Parameters:

static (Union[IResolvable, StaticPolicyDefinitionProperty, Dict[str, Any], None]) – A structure that describes a static policy. An static policy doesn’t use a template or allow placeholders for entities.
template_linked (Union[IResolvable, TemplateLinkedPolicyDefinitionProperty, Dict[str, Any], None]) –
A structure that describes a policy that was instantiated from a template. The template can specify placeholders for principal and resource . When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

policy_definition_property = verifiedpermissions.CfnPolicy.PolicyDefinitionProperty(
    static=verifiedpermissions.CfnPolicy.StaticPolicyDefinitionProperty(
        statement="statement",

        # the properties below are optional
        description="description"
    ),
    template_linked=verifiedpermissions.CfnPolicy.TemplateLinkedPolicyDefinitionProperty(
        policy_template_id="policyTemplateId",

        # the properties below are optional
        principal=verifiedpermissions.CfnPolicy.EntityIdentifierProperty(
            entity_id="entityId",
            entity_type="entityType"
        ),
        resource=verifiedpermissions.CfnPolicy.EntityIdentifierProperty(
            entity_id="entityId",
            entity_type="entityType"
        )
    )
)

Attributes

static

A structure that describes a static policy.

An static policy doesn’t use a template or allow placeholders for entities.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.html#cfn-verifiedpermissions-policy-policydefinition-static

template_linked

A structure that describes a policy that was instantiated from a template.

The template can specify placeholders for principal and resource . When you use CreatePolicy to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-policydefinition.html#cfn-verifiedpermissions-policy-policydefinition-templatelinked

StaticPolicyDefinitionProperty

class CfnPolicy.StaticPolicyDefinitionProperty(*, statement, description=None)

Bases: object

A structure that defines a static policy.

Parameters:

statement (str) – The policy content of the static policy, written in the Cedar policy language.
description (Optional[str]) – The description of the static policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-staticpolicydefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

static_policy_definition_property = verifiedpermissions.CfnPolicy.StaticPolicyDefinitionProperty(
    statement="statement",

    # the properties below are optional
    description="description"
)

Attributes

description

The description of the static policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-staticpolicydefinition.html#cfn-verifiedpermissions-policy-staticpolicydefinition-description

statement

The policy content of the static policy, written in the Cedar policy language.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-staticpolicydefinition.html#cfn-verifiedpermissions-policy-staticpolicydefinition-statement

TemplateLinkedPolicyDefinitionProperty

class CfnPolicy.TemplateLinkedPolicyDefinitionProperty(*, policy_template_id, principal=None, resource=None)

Bases: object

A structure that describes a policy created by instantiating a policy template.

You can’t directly update a template-linked policy. You must update the associated policy template instead.

Parameters:

policy_template_id (str) – The unique identifier of the policy template used to create this policy.
principal (Union[IResolvable, EntityIdentifierProperty, Dict[str, Any], None]) – The principal associated with this template-linked policy. Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.
resource (Union[IResolvable, EntityIdentifierProperty, Dict[str, Any], None]) – The resource associated with this template-linked policy. Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-templatelinkedpolicydefinition.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_verifiedpermissions as verifiedpermissions

template_linked_policy_definition_property = verifiedpermissions.CfnPolicy.TemplateLinkedPolicyDefinitionProperty(
    policy_template_id="policyTemplateId",

    # the properties below are optional
    principal=verifiedpermissions.CfnPolicy.EntityIdentifierProperty(
        entity_id="entityId",
        entity_type="entityType"
    ),
    resource=verifiedpermissions.CfnPolicy.EntityIdentifierProperty(
        entity_id="entityId",
        entity_type="entityType"
    )
)

Attributes

policy_template_id

The unique identifier of the policy template used to create this policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-templatelinkedpolicydefinition.html#cfn-verifiedpermissions-policy-templatelinkedpolicydefinition-policytemplateid

principal

The principal associated with this template-linked policy.

Verified Permissions substitutes this principal for the ?principal placeholder in the policy template when it evaluates an authorization request.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-templatelinkedpolicydefinition.html#cfn-verifiedpermissions-policy-templatelinkedpolicydefinition-principal

resource

The resource associated with this template-linked policy.

Verified Permissions substitutes this resource for the ?resource placeholder in the policy template when it evaluates an authorization request.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-verifiedpermissions-policy-templatelinkedpolicydefinition.html#cfn-verifiedpermissions-policy-templatelinkedpolicydefinition-resource