@piclemx/pulumi-opensearch/provider.d.ts

A Pulumi package for creating and managing Opensearch resources. Based on terraform-provider-opensearch: version v2.2.1

import * as pulumi from "@pulumi/pulumi";
/**
 * The provider type for the opensearch package. By default, resources use package-wide configuration
 * settings, however an explicit `Provider` instance may be created and passed during resource
 * construction to achieve fine-grained programmatic control over provider settings. See the
 * [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.
 */
export declare class Provider extends pulumi.ProviderResource {
    /**
     * Returns true if the given object is an instance of Provider.  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 Provider;
    /**
     * The access key for use with AWS OpenSearch Service domains
     */
    readonly awsAccessKey: pulumi.Output<string | undefined>;
    /**
     * Amazon Resource Name of an IAM Role to assume prior to making AWS API calls.
     */
    readonly awsAssumeRoleArn: pulumi.Output<string | undefined>;
    /**
     * External ID configured in the IAM policy of the IAM Role to assume prior to making AWS API calls.
     */
    readonly awsAssumeRoleExternalId: pulumi.Output<string | undefined>;
    /**
     * The AWS profile for use with AWS OpenSearch Service domains
     */
    readonly awsProfile: pulumi.Output<string | undefined>;
    /**
     * The AWS region for use in signing of AWS OpenSearch requests. Must be specified in order to use AWS URL signing with AWS
     * OpenSearch endpoint exposed on a custom DNS domain.
     */
    readonly awsRegion: pulumi.Output<string | undefined>;
    /**
     * The secret key for use with AWS OpenSearch Service domains
     */
    readonly awsSecretKey: pulumi.Output<string | undefined>;
    /**
     * AWS service name used in the credential scope of signed requests to OpenSearch.
     */
    readonly awsSignatureService: pulumi.Output<string | undefined>;
    /**
     * The session token for use with AWS OpenSearch Service domains
     */
    readonly awsToken: pulumi.Output<string | undefined>;
    /**
     * A Custom CA certificate
     */
    readonly cacertFile: pulumi.Output<string | undefined>;
    /**
     * A X509 certificate to connect to OpenSearch
     */
    readonly clientCertPath: pulumi.Output<string | undefined>;
    /**
     * A X509 key to connect to OpenSearch
     */
    readonly clientKeyPath: pulumi.Output<string | undefined>;
    /**
     * If provided, sets the 'Host' header of requests and the 'ServerName' for certificate validation to this value. See the
     * documentation on connecting to OpenSearch via an SSH tunnel.
     */
    readonly hostOverride: pulumi.Output<string | undefined>;
    /**
     * OpenSearch Version
     */
    readonly opensearchVersion: pulumi.Output<string | undefined>;
    /**
     * Password to use to connect to OpenSearch using basic auth
     */
    readonly password: pulumi.Output<string | undefined>;
    /**
     * Proxy URL to use for requests to OpenSearch.
     */
    readonly proxy: pulumi.Output<string | undefined>;
    /**
     * A bearer token or ApiKey for an Authorization header, e.g. Active Directory API key.
     */
    readonly token: pulumi.Output<string | undefined>;
    /**
     * The type of token, usually ApiKey or Bearer
     */
    readonly tokenName: pulumi.Output<string | undefined>;
    /**
     * OpenSearch URL
     */
    readonly url: pulumi.Output<string>;
    /**
     * Username to use to connect to OpenSearch using basic auth
     */
    readonly username: pulumi.Output<string | undefined>;
    /**
     * Create a Provider 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: ProviderArgs, opts?: pulumi.ResourceOptions);
}
/**
 * The set of arguments for constructing a Provider resource.
 */
export interface ProviderArgs {
    /**
     * The access key for use with AWS OpenSearch Service domains
     */
    awsAccessKey?: pulumi.Input<string>;
    /**
     * Amazon Resource Name of an IAM Role to assume prior to making AWS API calls.
     */
    awsAssumeRoleArn?: pulumi.Input<string>;
    /**
     * External ID configured in the IAM policy of the IAM Role to assume prior to making AWS API calls.
     */
    awsAssumeRoleExternalId?: pulumi.Input<string>;
    /**
     * The AWS profile for use with AWS OpenSearch Service domains
     */
    awsProfile?: pulumi.Input<string>;
    /**
     * The AWS region for use in signing of AWS OpenSearch requests. Must be specified in order to use AWS URL signing with AWS
     * OpenSearch endpoint exposed on a custom DNS domain.
     */
    awsRegion?: pulumi.Input<string>;
    /**
     * The secret key for use with AWS OpenSearch Service domains
     */
    awsSecretKey?: pulumi.Input<string>;
    /**
     * AWS service name used in the credential scope of signed requests to OpenSearch.
     */
    awsSignatureService?: pulumi.Input<string>;
    /**
     * The session token for use with AWS OpenSearch Service domains
     */
    awsToken?: pulumi.Input<string>;
    /**
     * A Custom CA certificate
     */
    cacertFile?: pulumi.Input<string>;
    /**
     * A X509 certificate to connect to OpenSearch
     */
    clientCertPath?: pulumi.Input<string>;
    /**
     * A X509 key to connect to OpenSearch
     */
    clientKeyPath?: pulumi.Input<string>;
    /**
     * Set the client healthcheck option for the OpenSearch client. Healthchecking is designed for direct access to the
     * cluster.
     */
    healthcheck?: pulumi.Input<boolean>;
    /**
     * If provided, sets the 'Host' header of requests and the 'ServerName' for certificate validation to this value. See the
     * documentation on connecting to OpenSearch via an SSH tunnel.
     */
    hostOverride?: pulumi.Input<string>;
    /**
     * Disable SSL verification of API calls
     */
    insecure?: pulumi.Input<boolean>;
    /**
     * OpenSearch Version
     */
    opensearchVersion?: pulumi.Input<string>;
    /**
     * Password to use to connect to OpenSearch using basic auth
     */
    password?: pulumi.Input<string>;
    /**
     * Proxy URL to use for requests to OpenSearch.
     */
    proxy?: pulumi.Input<string>;
    /**
     * Enable signing of AWS OpenSearch requests. The `url` must refer to AWS ES domain (`*.<region>.es.amazonaws.com`), or
     * `aws_region` must be specified explicitly.
     */
    signAwsRequests?: pulumi.Input<boolean>;
    /**
     * Set the node sniffing option for the OpenSearch client. Client won't work with sniffing if nodes are not routable.
     */
    sniff?: pulumi.Input<boolean>;
    /**
     * A bearer token or ApiKey for an Authorization header, e.g. Active Directory API key.
     */
    token?: pulumi.Input<string>;
    /**
     * The type of token, usually ApiKey or Bearer
     */
    tokenName?: pulumi.Input<string>;
    /**
     * OpenSearch URL
     */
    url: pulumi.Input<string>;
    /**
     * Username to use to connect to OpenSearch using basic auth
     */
    username?: pulumi.Input<string>;
    /**
     * Version ping timeout in seconds
     */
    versionPingTimeout?: pulumi.Input<number>;
}