Class: Aws::OpenSearchServerless::Types::CreateAccessPolicyRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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)


485
486
487
488
489
490
491
492
493
# File 'lib/aws-sdk-opensearchserverless/types.rb', line 485

class CreateAccessPolicyRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :policy,
  :type)
  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)


485
486
487
488
489
490
491
492
493
# File 'lib/aws-sdk-opensearchserverless/types.rb', line 485

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

#nameString

The name of the policy.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
# File 'lib/aws-sdk-opensearchserverless/types.rb', line 485

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

#policyString

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

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
# File 'lib/aws-sdk-opensearchserverless/types.rb', line 485

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

#typeString

The type of policy.

Returns:

  • (String)


485
486
487
488
489
490
491
492
493
# File 'lib/aws-sdk-opensearchserverless/types.rb', line 485

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