Create Security Policy

opensearchserviceserverless_create_security_policy

R Documentation

Creates a security policy to be used by one or more OpenSearch Serverless collections¶

Description¶

Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

Usage¶

opensearchserviceserverless_create_security_policy(clientToken,
  description, name, policy, type)

Arguments¶

clientToken: Unique, case-sensitive identifier to ensure idempotency of the request.
description: A description of the policy. Typically used to store information about the permissions defined in the policy.
name: [required] The name of the policy.
policy: [required] The JSON policy document to use as the content for the new policy.
type: [required] The type of security policy.

Value¶

A list with the following syntax:

list(
  securityPolicyDetail = list(
    createdDate = 123,
    description = "string",
    lastModifiedDate = 123,
    name = "string",
    policy = list(),
    policyVersion = "string",
    type = "encryption"|"network"
  )
)

Request syntax¶

svc$create_security_policy(
  clientToken = "string",
  description = "string",
  name = "string",
  policy = "string",
  type = "encryption"|"network"
)