Package software.amazon.awscdk.services.verifiedpermissions

Class CfnPolicyStore.Builder

java.lang.Object

software.amazon.awscdk.services.verifiedpermissions.CfnPolicyStore.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPolicyStore>

Enclosing class:

CfnPolicyStore

@Stability(Stable)
public static final class CfnPolicyStore.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPolicyStore>

A fluent builder for CfnPolicyStore.

Method Summary

Modifier and Type	Method	Description
CfnPolicyStore	build()
static CfnPolicyStore.Builder	create(software.constructs.Construct scope, String id)
CfnPolicyStore.Builder	description(String description)	Descriptive text that you can provide to help with identification of the current policy store.
CfnPolicyStore.Builder	schema(IResolvable schema)	Creates or updates the policy schema in a policy store.
CfnPolicyStore.Builder	schema(CfnPolicyStore.SchemaDefinitionProperty schema)	Creates or updates the policy schema in a policy store.
CfnPolicyStore.Builder	validationSettings(IResolvable validationSettings)	Specifies the validation setting for this policy store.
CfnPolicyStore.Builder	validationSettings(CfnPolicyStore.ValidationSettingsProperty validationSettings)	Specifies the validation setting for this policy store.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnPolicyStore.Builder create(software.constructs.Construct scope,
 String id)

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.

Returns:

a new instance of CfnPolicyStore.Builder.

validationSettings

@Stability(Stable)
public CfnPolicyStore.Builder validationSettings(IResolvable validationSettings)

Specifies the validation setting for this policy store.

Currently, the only valid and required value is Mode .

We recommend that you turn on STRICT mode only after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the UpdatePolicyStore . Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.

Parameters:

validationSettings - Specifies the validation setting for this policy store. This parameter is required.

Returns:

this

See Also:

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

validationSettings

@Stability(Stable)
public CfnPolicyStore.Builder validationSettings(CfnPolicyStore.ValidationSettingsProperty validationSettings)

Specifies the validation setting for this policy store.

Currently, the only valid and required value is Mode .

We recommend that you turn on STRICT mode only after you define a schema. If a schema doesn't exist, then STRICT mode causes any policy to fail validation, and Verified Permissions rejects the policy. You can turn off validation by using the UpdatePolicyStore . Then, when you have a schema defined, use UpdatePolicyStore again to turn validation back on.

Parameters:

validationSettings - Specifies the validation setting for this policy store. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnPolicyStore.Builder description(String description)

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

Parameters:

description - Descriptive text that you can provide to help with identification of the current policy store. This parameter is required.

Returns:

this

See Also:

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

schema

@Stability(Stable)
public CfnPolicyStore.Builder schema(IResolvable schema)

Creates or updates the policy schema in a policy store.

Cedar can use the schema to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.

Parameters:

schema - Creates or updates the policy schema in a policy store. This parameter is required.

Returns:

this

See Also:

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

schema

@Stability(Stable)
public CfnPolicyStore.Builder schema(CfnPolicyStore.SchemaDefinitionProperty schema)

Creates or updates the policy schema in a policy store.

Cedar can use the schema to validate any Cedar policies and policy templates submitted to the policy store. Any changes to the schema validate only policies and templates submitted after the schema change. Existing policies and templates are not re-evaluated against the changed schema. If you later update a policy, then it is evaluated against the new schema at that time.

Parameters:

schema - Creates or updates the policy schema in a policy store. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPolicyStore build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPolicyStore>

Returns:

a newly built instance of CfnPolicyStore.