Package software.amazon.awscdk.services.verifiedpermissions

Class CfnPolicyStore

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

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-24T02:42:45.588Z")
@Stability(Stable)
public class CfnPolicyStore
extends CfnResource
implements IInspectable

Creates a policy store.

A policy store is a container for policy resources. You can create a separate policy store for each of your applications.

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.*;
 CfnPolicyStore cfnPolicyStore = CfnPolicyStore.Builder.create(this, "MyCfnPolicyStore")
         .validationSettings(ValidationSettingsProperty.builder()
                 .mode("mode")
                 .build())
         // the properties below are optional
         .description("description")
         .schema(SchemaDefinitionProperty.builder()
                 .cedarJson("cedarJson")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-verifiedpermissions-policystore.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnPolicyStore.Builder	A fluent builder for CfnPolicyStore.
static interface	CfnPolicyStore.SchemaDefinitionProperty	Contains a list of principal types, resource types, and actions that can be specified in policies stored in the same policy store.
static interface	CfnPolicyStore.ValidationSettingsProperty	A structure that contains Cedar policy validation settings for the policy store.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnPolicyStore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPolicyStore(software.amazon.jsii.JsiiObjectRef objRef)
	CfnPolicyStore(software.constructs.Construct scope, String id, CfnPolicyStoreProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the new or updated policy store.
String	getAttrPolicyStoreId()	The unique ID of the new or updated policy store.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	Descriptive text that you can provide to help with identification of the current policy store.
Object	getSchema()	Creates or updates the policy schema in a policy store.
Object	getValidationSettings()	Specifies the validation setting for this policy store.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	Descriptive text that you can provide to help with identification of the current policy store.
void	setSchema(IResolvable value)	Creates or updates the policy schema in a policy store.
void	setSchema(CfnPolicyStore.SchemaDefinitionProperty value)	Creates or updates the policy schema in a policy store.
void	setValidationSettings(IResolvable value)	Specifies the validation setting for this policy store.
void	setValidationSettings(CfnPolicyStore.ValidationSettingsProperty value)	Specifies the validation setting for this policy store.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnPolicyStore

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

CfnPolicyStore

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

CfnPolicyStore

@Stability(Stable)
public CfnPolicyStore(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnPolicyStoreProps 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.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the new or updated policy store.

getAttrPolicyStoreId

@Stability(Stable)
@NotNull
public String getAttrPolicyStoreId()

The unique ID of the new or updated policy store.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getValidationSettings

@Stability(Stable)
@NotNull
public Object getValidationSettings()

Specifies the validation setting for this policy store.

setValidationSettings

@Stability(Stable)
public void setValidationSettings(@NotNull
 IResolvable value)

Specifies the validation setting for this policy store.

setValidationSettings

@Stability(Stable)
public void setValidationSettings(@NotNull
 CfnPolicyStore.ValidationSettingsProperty value)

Specifies the validation setting for this policy store.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

Descriptive text that you can provide to help with identification of the current policy store.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

Descriptive text that you can provide to help with identification of the current policy store.

getSchema

@Stability(Stable)
@Nullable
public Object getSchema()

Creates or updates the policy schema in a policy store.

setSchema

@Stability(Stable)
public void setSchema(@Nullable
 IResolvable value)

Creates or updates the policy schema in a policy store.

setSchema

@Stability(Stable)
public void setSchema(@Nullable
 CfnPolicyStore.SchemaDefinitionProperty value)

Creates or updates the policy schema in a policy store.