Package software.amazon.awscdk.services.verifiedpermissions

Class CfnPolicyTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.verifiedpermissions.CfnPolicyTemplate
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:14.797Z") @Stability(Stable) public class CfnPolicyTemplate extends CfnResource implements IInspectable
Creates a policy template.

A template can use placeholders for the principal and resource. A template must be instantiated into a policy by associating it with specific principals and resources to use for the placeholders. That instantiated policy can then be considered in authorization decisions. The instantiated policy works identically to any other policy, except that it is dynamically linked to the template. If the template changes, then any policies that are linked to that template are immediately updated as well.

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.*;
 CfnPolicyTemplate cfnPolicyTemplate = CfnPolicyTemplate.Builder.create(this, "MyCfnPolicyTemplate")
         .policyStoreId("policyStoreId")
         .statement("statement")
         // the properties below are optional
         .description("description")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPolicyTemplate

      protected CfnPolicyTemplate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPolicyTemplate

      protected CfnPolicyTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPolicyTemplate

      @Stability(Stable) public CfnPolicyTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPolicyTemplateProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrPolicyTemplateId

      @Stability(Stable) @NotNull public String getAttrPolicyTemplateId()
      The unique identifier of the new or modified policy template.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPolicyStoreId

      @Stability(Stable) @NotNull public String getPolicyStoreId()
      The unique identifier of the policy store that contains the template.

    • setPolicyStoreId

      @Stability(Stable) public void setPolicyStoreId(@NotNull String value)
      The unique identifier of the policy store that contains the template.

    • getStatement

      @Stability(Stable) @NotNull public String getStatement()
      Specifies the content that you want to use for the new policy template, written in the Cedar policy language.

    • setStatement

      @Stability(Stable) public void setStatement(@NotNull String value)
      Specifies the content that you want to use for the new policy template, written in the Cedar policy language.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description to attach to the new or updated policy template.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description to attach to the new or updated policy template.