Class: Aws::VerifiedPermissions::Types::PolicyDefinition

Inherits:
Struct
  • Object
show all
Includes:
Structure, Structure::Union
Defined in:
lib/aws-sdk-verifiedpermissions/types.rb

Overview

Note:

PolicyDefinition is a union - when making an API calls you must set exactly one of the members.

A structure that contains the details for a Cedar policy definition. It includes the policy type, a description, and a policy body. This is a top level data type used to create a policy.

This data type is used as a request parameter for the

CreatePolicy][1

operation. This structure must always have either an

‘static` or a `templateLinked` element.

[1]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html

See Also:

Direct Known Subclasses

Static, TemplateLinked, Unknown

Defined Under Namespace

Classes: Static, TemplateLinked, Unknown

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#static ⇒ Types::StaticPolicyDefinition

A structure that describes a static policy. An static policy doesn’t use a template or allow placeholders for entities.

Returns:



3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 3233

class PolicyDefinition < Struct.new(
  :static,
  :template_linked,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Static < PolicyDefinition; end
  class TemplateLinked < PolicyDefinition; end
  class Unknown < PolicyDefinition; end
end

#template_linked ⇒ Types::TemplateLinkedPolicyDefinition

A structure that describes a policy that was instantiated from a template. The template can specify placeholders for ‘principal` and `resource`. When you use [CreatePolicy] to create a policy from a template, you specify the exact principal and resource to use for the instantiated policy.

[1]: docs.aws.amazon.com/verifiedpermissions/latest/apireference/API_CreatePolicy.html

Returns:



3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 3233

class PolicyDefinition < Struct.new(
  :static,
  :template_linked,
  :unknown)
  SENSITIVE = []
  include Aws::Structure
  include Aws::Structure::Union

  class Static < PolicyDefinition; end
  class TemplateLinked < PolicyDefinition; end
  class Unknown < PolicyDefinition; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



3233
3234
3235
 
# File 'lib/aws-sdk-verifiedpermissions/types.rb', line 3233

def unknown
  @unknown
end