Class: AWSCDK::Verifiedpermissions::CfnPolicyStore

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSVerifiedpermissions::IPolicyStoreRef
Defined in:
verifiedpermissions/cfn_policy_store.rb

Overview

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.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPolicyStore

Create a new AWS::VerifiedPermissions::PolicyStore.

Parameters:



20
21
22
23
24
25
26
# File 'verifiedpermissions/cfn_policy_store.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Verifiedpermissions::CfnPolicyStoreProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfdmVyaWZpZWRwZXJtaXNzaW9ucy5DZm5Qb2xpY3lTdG9yZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_policy_store(resource) ⇒ String

Parameters:

Returns:

  • (String)


81
82
83
84
# File 'verifiedpermissions/cfn_policy_store.rb', line 81

def self.arn_for_policy_store(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c192ZXJpZmllZHBlcm1pc3Npb25zLklQb2xpY3lTdG9yZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_verifiedpermissions.CfnPolicyStore", "arnForPolicyStore", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


214
215
216
# File 'verifiedpermissions/cfn_policy_store.rb', line 214

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_verifiedpermissions.CfnPolicyStore", "CFN_RESOURCE_TYPE_NAME")
end

.from_policy_store_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSVerifiedpermissions::IPolicyStoreRef

Creates a new IPolicyStoreRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



92
93
94
95
96
97
# File 'verifiedpermissions/cfn_policy_store.rb', line 92

def self.from_policy_store_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_verifiedpermissions.CfnPolicyStore", "fromPolicyStoreArn", [scope, id, arn])
end

.from_policy_store_id(scope, id, policy_store_id) ⇒ AWSCDK::Interfaces::AWSVerifiedpermissions::IPolicyStoreRef

Creates a new IPolicyStoreRef from a policyStoreId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • policy_store_id (String)

Returns:



105
106
107
108
109
110
# File 'verifiedpermissions/cfn_policy_store.rb', line 105

def self.from_policy_store_id(scope, id, policy_store_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(policy_store_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "policyStoreId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_verifiedpermissions.CfnPolicyStore", "fromPolicyStoreId", [scope, id, policy_store_id])
end

.is_cfn_policy_store(x) ⇒ Boolean

Checks whether the given object is a CfnPolicyStore.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


116
117
118
119
# File 'verifiedpermissions/cfn_policy_store.rb', line 116

def self.is_cfn_policy_store(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_verifiedpermissions.CfnPolicyStore", "isCfnPolicyStore", [x])
end

.jsii_overridable_methodsObject



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'verifiedpermissions/cfn_policy_store.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_encryption_state => { kind: :property, name: "attrEncryptionState", is_optional: false },
    :attr_policy_store_id => { kind: :property, name: "attrPolicyStoreId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :policy_store_ref => { kind: :property, name: "policyStoreRef", is_optional: false },
    :validation_settings => { kind: :property, name: "validationSettings", is_optional: false },
    :deletion_protection => { kind: :property, name: "deletionProtection", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :encryption_settings => { kind: :property, name: "encryptionSettings", is_optional: true },
    :schema => { kind: :property, name: "schema", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String)

    The path of the value to delete.



364
365
366
367
# File 'verifiedpermissions/cfn_policy_store.rb', line 364

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



376
377
378
379
# File 'verifiedpermissions/cfn_policy_store.rb', line 376

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



386
387
388
389
# File 'verifiedpermissions/cfn_policy_store.rb', line 386

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.



397
398
399
400
401
# File 'verifiedpermissions/cfn_policy_store.rb', line 397

def (key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String)
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object)
    • The value.


454
455
456
457
458
# File 'verifiedpermissions/cfn_policy_store.rb', line 454

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String)

    The path to the property.



464
465
466
467
# File 'verifiedpermissions/cfn_policy_store.rb', line 464

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String)

    The path of the property.

  • value (Object)

    The value.



476
477
478
479
480
# File 'verifiedpermissions/cfn_policy_store.rb', line 476

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



489
490
491
492
# File 'verifiedpermissions/cfn_policy_store.rb', line 489

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:



511
512
513
514
515
516
# File 'verifiedpermissions/cfn_policy_store.rb', line 511

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arnString

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

Returns:

  • (String)


221
222
223
# File 'verifiedpermissions/cfn_policy_store.rb', line 221

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_encryption_stateAWSCDK::IResolvable

Returns:



226
227
228
# File 'verifiedpermissions/cfn_policy_store.rb', line 226

def attr_encryption_state()
  jsii_get_property("attrEncryptionState")
end

#attr_policy_store_idString

The unique ID of the new or updated policy store.

Returns:

  • (String)


233
234
235
# File 'verifiedpermissions/cfn_policy_store.rb', line 233

def attr_policy_store_id()
  jsii_get_property("attrPolicyStoreId")
end

#cdk_tag_managerAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



240
241
242
# File 'verifiedpermissions/cfn_policy_store.rb', line 240

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.



167
168
169
# File 'verifiedpermissions/cfn_policy_store.rb', line 167

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


172
173
174
# File 'verifiedpermissions/cfn_policy_store.rb', line 172

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


520
521
522
523
# File 'verifiedpermissions/cfn_policy_store.rb', line 520

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_namesHash{String => String}

Returns:

  • (Hash{String => String})


177
178
179
# File 'verifiedpermissions/cfn_policy_store.rb', line 177

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


184
185
186
# File 'verifiedpermissions/cfn_policy_store.rb', line 184

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


129
130
131
# File 'verifiedpermissions/cfn_policy_store.rb', line 129

def creation_stack()
  jsii_get_property("creationStack")
end

#deletion_protectionAWSCDK::IResolvable, ...

Specifies whether the policy store can be deleted.

If enabled, the policy store can't be deleted.



269
270
271
# File 'verifiedpermissions/cfn_policy_store.rb', line 269

def deletion_protection()
  jsii_get_property("deletionProtection")
end

#deletion_protection=(value) ⇒ Object



273
274
275
276
277
# File 'verifiedpermissions/cfn_policy_store.rb', line 273

def deletion_protection=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Verifiedpermissions::CfnPolicyStore::DeletionProtectionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c192ZXJpZmllZHBlcm1pc3Npb25zLkNmblBvbGljeVN0b3JlLkRlbGV0aW9uUHJvdGVjdGlvblByb3BlcnR5In1dfX0=")), "deletionProtection") unless value.nil?
  jsii_set_property("deletionProtection", value)
end

#descriptionString?

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

Returns:

  • (String, nil)


282
283
284
# File 'verifiedpermissions/cfn_policy_store.rb', line 282

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object



286
287
288
289
# File 'verifiedpermissions/cfn_policy_store.rb', line 286

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#encryption_settingsAWSCDK::IResolvable, ...



292
293
294
# File 'verifiedpermissions/cfn_policy_store.rb', line 292

def encryption_settings()
  jsii_get_property("encryptionSettings")
end

#encryption_settings=(value) ⇒ Object



296
297
298
299
300
# File 'verifiedpermissions/cfn_policy_store.rb', line 296

def encryption_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Verifiedpermissions::CfnPolicyStore::EncryptionSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c192ZXJpZmllZHBlcm1pc3Npb25zLkNmblBvbGljeVN0b3JlLkVuY3J5cHRpb25TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "encryptionSettings") unless value.nil?
  jsii_set_property("encryptionSettings", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



189
190
191
# File 'verifiedpermissions/cfn_policy_store.rb', line 189

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



533
534
535
536
537
# File 'verifiedpermissions/cfn_policy_store.rb', line 533

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.



544
545
546
547
# File 'verifiedpermissions/cfn_policy_store.rb', line 544

def (key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



614
615
616
617
# File 'verifiedpermissions/cfn_policy_store.rb', line 614

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_idString

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String)


141
142
143
# File 'verifiedpermissions/cfn_policy_store.rb', line 141

def logical_id()
  jsii_get_property("logicalId")
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


124
125
126
# File 'verifiedpermissions/cfn_policy_store.rb', line 124

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



555
556
557
# File 'verifiedpermissions/cfn_policy_store.rb', line 555

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



562
563
564
# File 'verifiedpermissions/cfn_policy_store.rb', line 562

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String)

    The new logical ID to use for this stack element.



355
356
357
358
# File 'verifiedpermissions/cfn_policy_store.rb', line 355

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#policy_store_refAWSCDK::Interfaces::AWSVerifiedpermissions::PolicyStoreReference

A reference to a PolicyStore resource.



247
248
249
# File 'verifiedpermissions/cfn_policy_store.rb', line 247

def policy_store_ref()
  jsii_get_property("policyStoreRef")
end

#refString

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String)


160
161
162
# File 'verifiedpermissions/cfn_policy_store.rb', line 160

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



573
574
575
576
# File 'verifiedpermissions/cfn_policy_store.rb', line 573

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object})


580
581
582
583
# File 'verifiedpermissions/cfn_policy_store.rb', line 580

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



590
591
592
593
594
# File 'verifiedpermissions/cfn_policy_store.rb', line 590

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#schemaAWSCDK::IResolvable, ...

Creates or updates the policy schema in a policy store.



305
306
307
# File 'verifiedpermissions/cfn_policy_store.rb', line 305

def schema()
  jsii_get_property("schema")
end

#schema=(value) ⇒ Object



309
310
311
312
313
# File 'verifiedpermissions/cfn_policy_store.rb', line 309

def schema=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Verifiedpermissions::CfnPolicyStore::SchemaDefinitionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c192ZXJpZmllZHBlcm1pc3Npb25zLkNmblBvbGljeVN0b3JlLlNjaGVtYURlZmluaXRpb25Qcm9wZXJ0eSJ9XX19")), "schema") unless value.nil?
  jsii_set_property("schema", value)
end

#should_synthesizeBoolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean)

    true if the resource should be included or false is the resource should be omitted.



599
600
601
# File 'verifiedpermissions/cfn_policy_store.rb', line 599

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stackAWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



150
151
152
# File 'verifiedpermissions/cfn_policy_store.rb', line 150

def stack()
  jsii_get_property("stack")
end

#tagsArray<AWSCDK::CfnTag>?

The list of key-value pairs to associate with the policy store.

Returns:



318
319
320
# File 'verifiedpermissions/cfn_policy_store.rb', line 318

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object



322
323
324
325
326
# File 'verifiedpermissions/cfn_policy_store.rb', line 322

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



331
332
333
# File 'verifiedpermissions/cfn_policy_store.rb', line 331

def to_string()
  jsii_call_method("toString", [])
end

#updated_properitesHash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object})


197
198
199
# File 'verifiedpermissions/cfn_policy_store.rb', line 197

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object})


207
208
209
# File 'verifiedpermissions/cfn_policy_store.rb', line 207

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


605
606
607
608
# File 'verifiedpermissions/cfn_policy_store.rb', line 605

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#validation_settingsAWSCDK::IResolvable, AWSCDK::Verifiedpermissions::CfnPolicyStore::ValidationSettingsProperty

Specifies the validation setting for this policy store.



254
255
256
# File 'verifiedpermissions/cfn_policy_store.rb', line 254

def validation_settings()
  jsii_get_property("validationSettings")
end

#validation_settings=(value) ⇒ Object



258
259
260
261
262
# File 'verifiedpermissions/cfn_policy_store.rb', line 258

def validation_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Verifiedpermissions::CfnPolicyStore::ValidationSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c192ZXJpZmllZHBlcm1pc3Npb25zLkNmblBvbGljeVN0b3JlLlZhbGlkYXRpb25TZXR0aW5nc1Byb3BlcnR5In1dfX0=")), "validationSettings")
  jsii_set_property("validationSettings", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct)


344
345
346
347
348
349
# File 'verifiedpermissions/cfn_policy_store.rb', line 344

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end