Class: Aws::OpenSearchServerless::Types::UpdateAccessPolicyRequest

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchServerless::Types::UpdateAccessPolicyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-opensearchserverless/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier to ensure idempotency of the request.

• #description ⇒ String

  A description of the policy.

• #name ⇒ String

  The name of the policy.

• #policy ⇒ String

  The JSON policy document to use as the content for the policy.

• #policy_version ⇒ String

  The version of the policy being updated.

• #type ⇒ String

  The type of policy.

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier to ensure idempotency of the request.

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

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 2295

class UpdateAccessPolicyRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :policy,
  :policy_version,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the policy. Typically used to store information about the permissions defined in the policy.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 2295

class UpdateAccessPolicyRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :policy,
  :policy_version,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the policy.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 2295

class UpdateAccessPolicyRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :policy,
  :policy_version,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#policy ⇒ String

The JSON policy document to use as the content for the policy.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 2295

class UpdateAccessPolicyRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :policy,
  :policy_version,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#policy_version ⇒ String

The version of the policy being updated.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 2295

class UpdateAccessPolicyRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :policy,
  :policy_version,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of policy.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 2295

class UpdateAccessPolicyRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :policy,
  :policy_version,
  :type)
  SENSITIVE = []
  include Aws::Structure
end