Package software.amazon.awscdk.services.verifiedpermissions

Interface CfnPolicy.TemplateLinkedPolicyDefinitionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPolicy.TemplateLinkedPolicyDefinitionProperty.Jsii$Proxy

Enclosing class:

CfnPolicy

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

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.

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.*;
 TemplateLinkedPolicyDefinitionProperty templateLinkedPolicyDefinitionProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPolicy.TemplateLinkedPolicyDefinitionProperty.Builder	builder()
String	getPolicyTemplateId()	The unique identifier of the policy template used to create this policy.
default Object	getPrincipal()	The principal associated with this template-linked policy.
default Object	getResource()	The resource associated with this template-linked policy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyTemplateId

@Stability(Stable)
@NotNull
String getPolicyTemplateId()

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

See Also:

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

getPrincipal

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

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.

Returns union: either IResolvable or CfnPolicy.EntityIdentifierProperty

See Also:

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

getResource

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

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.

Returns union: either IResolvable or CfnPolicy.EntityIdentifierProperty

See Also:

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

builder

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

Returns:

a CfnPolicy.TemplateLinkedPolicyDefinitionProperty.Builder of CfnPolicy.TemplateLinkedPolicyDefinitionProperty