Class: Aws::VerifiedPermissions::Types::CreatePolicyInput

Inherits:

Struct

• Object
• Struct
• Aws::VerifiedPermissions::Types::CreatePolicyInput

Defined in:

gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request.

• #definition ⇒ Types::PolicyDefinition

  A structure that specifies the policy type and content to use for the new policy.

• #name ⇒ String

  Specifies a name for the policy that is unique among all policies within the policy store.

• #policy_store_id ⇒ String

  Specifies the PolicyStoreId of the policy store you want to store the policy in.

Instance Attribute Details

#client_token ⇒ String

Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

If you don't provide this value, then Amazon Web Services generates a random one for you.

If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1438

class CreatePolicyInput < Struct.new(
  :client_token,
  :policy_store_id,
  :definition,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#definition ⇒ Types::PolicyDefinition

A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.

Returns:

• (Types::PolicyDefinition)

# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1438

class CreatePolicyInput < Struct.new(
  :client_token,
  :policy_store_id,
  :definition,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with name/.

If you specify a name that is already associated with another policy in the policy store, you receive a ConflictException error.

Returns:

• (String)

# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1438

class CreatePolicyInput < Struct.new(
  :client_token,
  :policy_store_id,
  :definition,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#policy_store_id ⇒ String

Specifies the PolicyStoreId of the policy store you want to store the policy in.

To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

• ID: PSEXAMPLEabcdefg111111

• Alias name: policy-store-alias/example-policy-store

To view aliases, use ListPolicyStoreAliases.

Returns:

• (String)

# File 'gems/aws-sdk-verifiedpermissions/lib/aws-sdk-verifiedpermissions/types.rb', line 1438

class CreatePolicyInput < Struct.new(
  :client_token,
  :policy_store_id,
  :definition,
  :name)
  SENSITIVE = []
  include Aws::Structure
end