Package software.amazon.awscdk.services.verifiedpermissions

Interface CfnPolicy.PolicyDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPolicy.PolicyDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnPolicy

@Stability(Stable)
public static interface CfnPolicy.PolicyDefinitionProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.verifiedpermissions.*;
 PolicyDefinitionProperty policyDefinitionProperty = PolicyDefinitionProperty.builder()
         .static(StaticPolicyDefinitionProperty.builder()
                 .statement("statement")
                 // the properties below are optional
                 .description("description")
                 .build())
         .templateLinked(TemplateLinkedPolicyDefinitionProperty.builder()
                 .policyTemplateId("policyTemplateId")
                 // the properties below are optional
                 .principal(EntityIdentifierProperty.builder()
                         .entityId("entityId")
                         .entityType("entityType")
                         .build())
                 .resource(EntityIdentifierProperty.builder()
                         .entityId("entityId")
                         .entityType("entityType")
                         .build())
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPolicy.PolicyDefinitionProperty.Builder	A builder for CfnPolicy.PolicyDefinitionProperty
static final class	CfnPolicy.PolicyDefinitionProperty.Jsii$Proxy	An implementation for CfnPolicy.PolicyDefinitionProperty

Method Summary

Modifier and Type	Method	Description
static CfnPolicy.PolicyDefinitionProperty.Builder	builder()
default Object	getStaticValue()	A structure that describes a static policy.
default Object	getTemplateLinked()	A structure that describes a policy that was instantiated from a template.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStaticValue

@Stability(Stable)
@Nullable
default Object getStaticValue()

A structure that describes a static policy.

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

See Also:

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

getTemplateLinked

@Stability(Stable)
@Nullable
default Object getTemplateLinked()

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 Also:

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

builder

@Stability(Stable)
static CfnPolicy.PolicyDefinitionProperty.Builder builder()

Returns:

a CfnPolicy.PolicyDefinitionProperty.Builder of CfnPolicy.PolicyDefinitionProperty