Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. opensearchserverless
  5. getAccessPolicy

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.opensearchserverless.getAccessPolicy

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Amazon OpenSearchServerless access policy resource

Using getAccessPolicy

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAccessPolicy(args: GetAccessPolicyArgs, opts?: InvokeOptions): Promise<GetAccessPolicyResult>
function getAccessPolicyOutput(args: GetAccessPolicyOutputArgs, opts?: InvokeOptions): Output<GetAccessPolicyResult>
Copy
def get_access_policy(name: Optional[str] = None,
                      type: Optional[AccessPolicyType] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAccessPolicyResult
def get_access_policy_output(name: Optional[pulumi.Input[str]] = None,
                      type: Optional[pulumi.Input[AccessPolicyType]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetAccessPolicyResult]
Copy
func LookupAccessPolicy(ctx *Context, args *LookupAccessPolicyArgs, opts ...InvokeOption) (*LookupAccessPolicyResult, error)
func LookupAccessPolicyOutput(ctx *Context, args *LookupAccessPolicyOutputArgs, opts ...InvokeOption) LookupAccessPolicyResultOutput
Copy

> Note: This function is named LookupAccessPolicy in the Go SDK.

public static class GetAccessPolicy 
{
    public static Task<GetAccessPolicyResult> InvokeAsync(GetAccessPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessPolicyResult> Invoke(GetAccessPolicyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAccessPolicyResult> getAccessPolicy(GetAccessPolicyArgs args, InvokeOptions options)
public static Output<GetAccessPolicyResult> getAccessPolicy(GetAccessPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:opensearchserverless:getAccessPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the policy
Type This property is required. Pulumi.AwsNative.OpenSearchServerless.AccessPolicyType
The type of access policy. Currently the only option is data .
Name This property is required. string
The name of the policy
Type This property is required. AccessPolicyType
The type of access policy. Currently the only option is data .
name This property is required. String
The name of the policy
type This property is required. AccessPolicyType
The type of access policy. Currently the only option is data .
name This property is required. string
The name of the policy
type This property is required. AccessPolicyType
The type of access policy. Currently the only option is data .
name This property is required. str
The name of the policy
type This property is required. AccessPolicyType
The type of access policy. Currently the only option is data .
name This property is required. String
The name of the policy
type This property is required. "data"
The type of access policy. Currently the only option is data .

getAccessPolicy Result

The following output properties are available:

Description string
The description of the policy
Policy string
The JSON policy document that is the content for the policy
Description string
The description of the policy
Policy string
The JSON policy document that is the content for the policy
description String
The description of the policy
policy String
The JSON policy document that is the content for the policy
description string
The description of the policy
policy string
The JSON policy document that is the content for the policy
description str
The description of the policy
policy str
The JSON policy document that is the content for the policy
description String
The description of the policy
policy String
The JSON policy document that is the content for the policy

Supporting Types

AccessPolicyType

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native