Class: Aws::VerifiedPermissions::Types::ContextDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb

Overview

Note:

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

Note:

ContextDefinition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ContextDefinition corresponding to the set member.

Contains additional details about the context of the request. Verified Permissions evaluates this information in an authorization request as part of the when and unless clauses in a policy.

This data type is used as a request parameter for the IsAuthorized, BatchIsAuthorized, and IsAuthorizedWithToken operations.

If you're passing context as part of the request, exactly one instance of context must be passed. If you don't want to pass context, omit the context parameter from your request rather than sending context {}.

Example: "context":{"contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}}

See Also:

Direct Known Subclasses

CedarJson, ContextMap, Unknown

Defined Under Namespace

Classes: CedarJson, ContextMap, Unknown

Constant Summary collapse

SENSITIVE = 
[:context_map, :cedar_json]

Instance Attribute Summary collapse

Instance Attribute Details

#cedar_json ⇒ String

A Cedar JSON string representation of the context needed to successfully evaluate an authorization request.

Example: {"cedarJson":"{"<KeyName1>": true, "<KeyName2>": 1234}" }

Returns:

  • (String) 


1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1225

class ContextDefinition < Struct.new(
  :context_map,
  :cedar_json,
  :unknown)
  SENSITIVE = [:context_map, :cedar_json]
  include Aws::Structure
  include Aws::Structure::Union

  class ContextMap < ContextDefinition; end
  class CedarJson < ContextDefinition; end
  class Unknown < ContextDefinition; end
end

#context_map ⇒ Hash<String,Types::AttributeValue>

An list of attributes that are needed to successfully evaluate an authorization request. Each attribute in this array must include a map of a data type and its value.

Example: "contextMap":{"<KeyName1>":{"boolean":true},"<KeyName2>":{"long":1234}}

Returns:



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1225

class ContextDefinition < Struct.new(
  :context_map,
  :cedar_json,
  :unknown)
  SENSITIVE = [:context_map, :cedar_json]
  include Aws::Structure
  include Aws::Structure::Union

  class ContextMap < ContextDefinition; end
  class CedarJson < ContextDefinition; end
  class Unknown < ContextDefinition; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



1225
1226
1227
 
# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1225

def unknown
  @unknown
end