amazonka-opensearchserverless-2.0: Amazon OpenSearch Service Serverless SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.OpenSearchServerless.CreateSecurityPolicy

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.

Synopsis

Creating a Request

data CreateSecurityPolicy Source #

See: newCreateSecurityPolicy smart constructor.

Constructors

CreateSecurityPolicy' 

Fields

Instances

Instances details
ToJSON CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

ToHeaders CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

ToPath CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

ToQuery CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

AWSRequest CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

Associated Types

type AWSResponse CreateSecurityPolicy #

Generic CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

Associated Types

type Rep CreateSecurityPolicy :: Type -> Type #

Read CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

Show CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

NFData CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

Methods

rnf :: CreateSecurityPolicy -> () #

Eq CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

Hashable CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

type AWSResponse CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

type Rep CreateSecurityPolicy Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

type Rep CreateSecurityPolicy = D1 ('MetaData "CreateSecurityPolicy" "Amazonka.OpenSearchServerless.CreateSecurityPolicy" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "CreateSecurityPolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SecurityPolicyType)))))

newCreateSecurityPolicy Source #

Create a value of CreateSecurityPolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientToken:CreateSecurityPolicy', createSecurityPolicy_clientToken - Unique, case-sensitive identifier to ensure idempotency of the request.

CreateSecurityPolicy, createSecurityPolicy_description - A description of the policy. Typically used to store information about the permissions defined in the policy.

CreateSecurityPolicy, createSecurityPolicy_name - The name of the policy.

CreateSecurityPolicy, createSecurityPolicy_policy - The JSON policy document to use as the content for the new policy.

CreateSecurityPolicy, createSecurityPolicy_type - The type of security policy.

Request Lenses

createSecurityPolicy_clientToken :: Lens' CreateSecurityPolicy (Maybe Text) Source #

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

createSecurityPolicy_description :: Lens' CreateSecurityPolicy (Maybe Text) Source #

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

createSecurityPolicy_policy :: Lens' CreateSecurityPolicy Text Source #

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

Destructuring the Response

data CreateSecurityPolicyResponse Source #

See: newCreateSecurityPolicyResponse smart constructor.

Constructors

CreateSecurityPolicyResponse' 

Fields

Instances

Instances details
Generic CreateSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

Associated Types

type Rep CreateSecurityPolicyResponse :: Type -> Type #

Read CreateSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

Show CreateSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

NFData CreateSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

Eq CreateSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

type Rep CreateSecurityPolicyResponse Source # 
Instance details

Defined in Amazonka.OpenSearchServerless.CreateSecurityPolicy

type Rep CreateSecurityPolicyResponse = D1 ('MetaData "CreateSecurityPolicyResponse" "Amazonka.OpenSearchServerless.CreateSecurityPolicy" "amazonka-opensearchserverless-2.0-HnbMYszmsxrAMKjbvSoFws" 'False) (C1 ('MetaCons "CreateSecurityPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "securityPolicyDetail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityPolicyDetail)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSecurityPolicyResponse Source #

Create a value of CreateSecurityPolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:securityPolicyDetail:CreateSecurityPolicyResponse', createSecurityPolicyResponse_securityPolicyDetail - Details about the created security policy.

$sel:httpStatus:CreateSecurityPolicyResponse', createSecurityPolicyResponse_httpStatus - The response's http status code.

Response Lenses