@piclemx/pulumi-opensearch
Version:
A Pulumi package for creating and managing Opensearch resources. Based on terraform-provider-opensearch: version v2.2.1
135 lines (134 loc) • 4.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an OpenSearch security role mapping. Please refer to the OpenSearch Access Control documentation for details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opensearch from "@piclemx/pulumi-opensearch";
*
* // Create a role mapping
* const mapper = new opensearch.RolesMapping("mapper", {
* backendRoles: [
* "arn:aws:iam::123456789012:role/lambda-call-opensearch",
* "arn:aws:iam::123456789012:role/run-containers",
* ],
* description: "Mapping AWS IAM roles to ES role",
* roleName: "logs_writer",
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import opensearch:index/rolesMapping:RolesMapping mapper logs_writer
* ```
*/
export declare class RolesMapping extends pulumi.CustomResource {
/**
* Get an existing RolesMapping resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RolesMappingState, opts?: pulumi.CustomResourceOptions): RolesMapping;
/**
* Returns true if the given object is an instance of RolesMapping. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is RolesMapping;
/**
* A list of backend roles.
*/
readonly andBackendRoles: pulumi.Output<string[] | undefined>;
/**
* A list of backend roles.
*/
readonly backendRoles: pulumi.Output<string[] | undefined>;
/**
* Description of the role mapping.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* A list of host names.
*/
readonly hosts: pulumi.Output<string[] | undefined>;
/**
* The name of the security role.
*/
readonly roleName: pulumi.Output<string>;
/**
* A list of users.
*/
readonly users: pulumi.Output<string[] | undefined>;
/**
* Create a RolesMapping resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: RolesMappingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RolesMapping resources.
*/
export interface RolesMappingState {
/**
* A list of backend roles.
*/
andBackendRoles?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A list of backend roles.
*/
backendRoles?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of the role mapping.
*/
description?: pulumi.Input<string>;
/**
* A list of host names.
*/
hosts?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the security role.
*/
roleName?: pulumi.Input<string>;
/**
* A list of users.
*/
users?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a RolesMapping resource.
*/
export interface RolesMappingArgs {
/**
* A list of backend roles.
*/
andBackendRoles?: pulumi.Input<pulumi.Input<string>[]>;
/**
* A list of backend roles.
*/
backendRoles?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Description of the role mapping.
*/
description?: pulumi.Input<string>;
/**
* A list of host names.
*/
hosts?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The name of the security role.
*/
roleName: pulumi.Input<string>;
/**
* A list of users.
*/
users?: pulumi.Input<pulumi.Input<string>[]>;
}