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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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)


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2422

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

#descriptionString

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

Returns:

  • (String)


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2422

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

#nameString

The name of the policy.

Returns:

  • (String)


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2422

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

#policyString

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

Returns:

  • (String)


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2422

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

#policy_versionString

The version of the policy being updated.

Returns:

  • (String)


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2422

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

#typeString

The type of policy.

Returns:

  • (String)


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2422

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