@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
93 lines (92 loc) • 2.88 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Data source for managing an AWS OpenSearch Serverless Access Policy.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.opensearch.getServerlessAccessPolicy({
* name: exampleAwsOpensearchserverlessAccessPolicy.name,
* type: exampleAwsOpensearchserverlessAccessPolicy.type,
* });
* ```
*/
export declare function getServerlessAccessPolicy(args: GetServerlessAccessPolicyArgs, opts?: pulumi.InvokeOptions): Promise<GetServerlessAccessPolicyResult>;
/**
* A collection of arguments for invoking getServerlessAccessPolicy.
*/
export interface GetServerlessAccessPolicyArgs {
/**
* Name of the policy.
*/
name: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
/**
* Type of access policy. Must be `data`.
*/
type: string;
}
/**
* A collection of values returned by getServerlessAccessPolicy.
*/
export interface GetServerlessAccessPolicyResult {
/**
* Description of the policy. Typically used to store information about the permissions defined in the policy.
*/
readonly description: string;
readonly id: string;
readonly name: string;
/**
* JSON policy document to use as the content for the new policy.
*/
readonly policy: string;
/**
* Version of the policy.
*/
readonly policyVersion: string;
readonly region: string;
readonly type: string;
}
/**
* Data source for managing an AWS OpenSearch Serverless Access Policy.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.opensearch.getServerlessAccessPolicy({
* name: exampleAwsOpensearchserverlessAccessPolicy.name,
* type: exampleAwsOpensearchserverlessAccessPolicy.type,
* });
* ```
*/
export declare function getServerlessAccessPolicyOutput(args: GetServerlessAccessPolicyOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServerlessAccessPolicyResult>;
/**
* A collection of arguments for invoking getServerlessAccessPolicy.
*/
export interface GetServerlessAccessPolicyOutputArgs {
/**
* Name of the policy.
*/
name: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Type of access policy. Must be `data`.
*/
type: pulumi.Input<string>;
}