Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opensearch Provider
  3. API Docs
  4. Provider
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
opensearch-project/terraform-provider-opensearch

opensearch.Provider

Explore with Pulumi AI

opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
opensearch-project/terraform-provider-opensearch

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 for more information.

Create Provider Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);
@overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             aws_access_key: Optional[str] = None,
             aws_assume_role_arn: Optional[str] = None,
             aws_assume_role_external_id: Optional[str] = None,
             aws_profile: Optional[str] = None,
             aws_region: Optional[str] = None,
             aws_secret_key: Optional[str] = None,
             aws_signature_service: Optional[str] = None,
             aws_token: Optional[str] = None,
             cacert_file: Optional[str] = None,
             client_cert_path: Optional[str] = None,
             client_key_path: Optional[str] = None,
             healthcheck: Optional[bool] = None,
             host_override: Optional[str] = None,
             insecure: Optional[bool] = None,
             opensearch_version: Optional[str] = None,
             password: Optional[str] = None,
             proxy: Optional[str] = None,
             sign_aws_requests: Optional[bool] = None,
             sniff: Optional[bool] = None,
             token: Optional[str] = None,
             token_name: Optional[str] = None,
             url: Optional[str] = None,
             username: Optional[str] = None,
             version_ping_timeout: Optional[float] = None)
func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)
public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)
public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:opensearch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Provider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Provider resource accepts the following input properties:

Url This property is required. string
OpenSearch URL
AwsAccessKey string
The access key for use with AWS OpenSearch Service domains
AwsAssumeRoleArn string
Amazon Resource Name of an IAM Role to assume prior to making AWS API calls.
AwsAssumeRoleExternalId string
External ID configured in the IAM policy of the IAM Role to assume prior to making AWS API calls.
AwsProfile string
The AWS profile for use with AWS OpenSearch Service domains
AwsRegion 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.
AwsSecretKey string
The secret key for use with AWS OpenSearch Service domains
AwsSignatureService string
AWS service name used in the credential scope of signed requests to OpenSearch.
AwsToken string
The session token for use with AWS OpenSearch Service domains
CacertFile string
A Custom CA certificate
ClientCertPath string
A X509 certificate to connect to OpenSearch
ClientKeyPath string
A X509 key to connect to OpenSearch
Healthcheck bool
Set the client healthcheck option for the OpenSearch client. Healthchecking is designed for direct access to the cluster.
HostOverride string
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.
Insecure bool
Disable SSL verification of API calls
OpensearchVersion string
OpenSearch Version
Password string
Password to use to connect to OpenSearch using basic auth
Proxy string
Proxy URL to use for requests to OpenSearch.
SignAwsRequests bool
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.
Sniff bool
Set the node sniffing option for the OpenSearch client. Client won't work with sniffing if nodes are not routable.
Token string
A bearer token or ApiKey for an Authorization header, e.g. Active Directory API key.
TokenName string
The type of token, usually ApiKey or Bearer
Username string
Username to use to connect to OpenSearch using basic auth
VersionPingTimeout double
Version ping timeout in seconds
Url This property is required. string
OpenSearch URL
AwsAccessKey string
The access key for use with AWS OpenSearch Service domains
AwsAssumeRoleArn string
Amazon Resource Name of an IAM Role to assume prior to making AWS API calls.
AwsAssumeRoleExternalId string
External ID configured in the IAM policy of the IAM Role to assume prior to making AWS API calls.
AwsProfile string
The AWS profile for use with AWS OpenSearch Service domains
AwsRegion 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.
AwsSecretKey string
The secret key for use with AWS OpenSearch Service domains
AwsSignatureService string
AWS service name used in the credential scope of signed requests to OpenSearch.
AwsToken string
The session token for use with AWS OpenSearch Service domains
CacertFile string
A Custom CA certificate
ClientCertPath string
A X509 certificate to connect to OpenSearch
ClientKeyPath string
A X509 key to connect to OpenSearch
Healthcheck bool
Set the client healthcheck option for the OpenSearch client. Healthchecking is designed for direct access to the cluster.
HostOverride string
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.
Insecure bool
Disable SSL verification of API calls
OpensearchVersion string
OpenSearch Version
Password string
Password to use to connect to OpenSearch using basic auth
Proxy string
Proxy URL to use for requests to OpenSearch.
SignAwsRequests bool
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.
Sniff bool
Set the node sniffing option for the OpenSearch client. Client won't work with sniffing if nodes are not routable.
Token string
A bearer token or ApiKey for an Authorization header, e.g. Active Directory API key.
TokenName string
The type of token, usually ApiKey or Bearer
Username string
Username to use to connect to OpenSearch using basic auth
VersionPingTimeout float64
Version ping timeout in seconds
url This property is required. String
OpenSearch URL
awsAccessKey String
The access key for use with AWS OpenSearch Service domains
awsAssumeRoleArn String
Amazon Resource Name of an IAM Role to assume prior to making AWS API calls.
awsAssumeRoleExternalId String
External ID configured in the IAM policy of the IAM Role to assume prior to making AWS API calls.
awsProfile String
The AWS profile for use with AWS OpenSearch Service domains
awsRegion 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.
awsSecretKey String
The secret key for use with AWS OpenSearch Service domains
awsSignatureService String
AWS service name used in the credential scope of signed requests to OpenSearch.
awsToken String
The session token for use with AWS OpenSearch Service domains
cacertFile String
A Custom CA certificate
clientCertPath String
A X509 certificate to connect to OpenSearch
clientKeyPath String
A X509 key to connect to OpenSearch
healthcheck Boolean
Set the client healthcheck option for the OpenSearch client. Healthchecking is designed for direct access to the cluster.
hostOverride String
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.
insecure Boolean
Disable SSL verification of API calls
opensearchVersion String
OpenSearch Version
password String
Password to use to connect to OpenSearch using basic auth
proxy String
Proxy URL to use for requests to OpenSearch.
signAwsRequests Boolean
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.
sniff Boolean
Set the node sniffing option for the OpenSearch client. Client won't work with sniffing if nodes are not routable.
token String
A bearer token or ApiKey for an Authorization header, e.g. Active Directory API key.
tokenName String
The type of token, usually ApiKey or Bearer
username String
Username to use to connect to OpenSearch using basic auth
versionPingTimeout Double
Version ping timeout in seconds
url This property is required. string
OpenSearch URL
awsAccessKey string
The access key for use with AWS OpenSearch Service domains
awsAssumeRoleArn string
Amazon Resource Name of an IAM Role to assume prior to making AWS API calls.
awsAssumeRoleExternalId string
External ID configured in the IAM policy of the IAM Role to assume prior to making AWS API calls.
awsProfile string
The AWS profile for use with AWS OpenSearch Service domains
awsRegion 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.
awsSecretKey string
The secret key for use with AWS OpenSearch Service domains
awsSignatureService string
AWS service name used in the credential scope of signed requests to OpenSearch.
awsToken string
The session token for use with AWS OpenSearch Service domains
cacertFile string
A Custom CA certificate
clientCertPath string
A X509 certificate to connect to OpenSearch
clientKeyPath string
A X509 key to connect to OpenSearch
healthcheck boolean
Set the client healthcheck option for the OpenSearch client. Healthchecking is designed for direct access to the cluster.
hostOverride string
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.
insecure boolean
Disable SSL verification of API calls
opensearchVersion string
OpenSearch Version
password string
Password to use to connect to OpenSearch using basic auth
proxy string
Proxy URL to use for requests to OpenSearch.
signAwsRequests boolean
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.
sniff boolean
Set the node sniffing option for the OpenSearch client. Client won't work with sniffing if nodes are not routable.
token string
A bearer token or ApiKey for an Authorization header, e.g. Active Directory API key.
tokenName string
The type of token, usually ApiKey or Bearer
username string
Username to use to connect to OpenSearch using basic auth
versionPingTimeout number
Version ping timeout in seconds
url This property is required. str
OpenSearch URL
aws_access_key str
The access key for use with AWS OpenSearch Service domains
aws_assume_role_arn str
Amazon Resource Name of an IAM Role to assume prior to making AWS API calls.
aws_assume_role_external_id str
External ID configured in the IAM policy of the IAM Role to assume prior to making AWS API calls.
aws_profile str
The AWS profile for use with AWS OpenSearch Service domains
aws_region str
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.
aws_secret_key str
The secret key for use with AWS OpenSearch Service domains
aws_signature_service str
AWS service name used in the credential scope of signed requests to OpenSearch.
aws_token str
The session token for use with AWS OpenSearch Service domains
cacert_file str
A Custom CA certificate
client_cert_path str
A X509 certificate to connect to OpenSearch
client_key_path str
A X509 key to connect to OpenSearch
healthcheck bool
Set the client healthcheck option for the OpenSearch client. Healthchecking is designed for direct access to the cluster.
host_override str
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.
insecure bool
Disable SSL verification of API calls
opensearch_version str
OpenSearch Version
password str
Password to use to connect to OpenSearch using basic auth
proxy str
Proxy URL to use for requests to OpenSearch.
sign_aws_requests bool
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.
sniff bool
Set the node sniffing option for the OpenSearch client. Client won't work with sniffing if nodes are not routable.
token str
A bearer token or ApiKey for an Authorization header, e.g. Active Directory API key.
token_name str
The type of token, usually ApiKey or Bearer
username str
Username to use to connect to OpenSearch using basic auth
version_ping_timeout float
Version ping timeout in seconds
url This property is required. String
OpenSearch URL
awsAccessKey String
The access key for use with AWS OpenSearch Service domains
awsAssumeRoleArn String
Amazon Resource Name of an IAM Role to assume prior to making AWS API calls.
awsAssumeRoleExternalId String
External ID configured in the IAM policy of the IAM Role to assume prior to making AWS API calls.
awsProfile String
The AWS profile for use with AWS OpenSearch Service domains
awsRegion 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.
awsSecretKey String
The secret key for use with AWS OpenSearch Service domains
awsSignatureService String
AWS service name used in the credential scope of signed requests to OpenSearch.
awsToken String
The session token for use with AWS OpenSearch Service domains
cacertFile String
A Custom CA certificate
clientCertPath String
A X509 certificate to connect to OpenSearch
clientKeyPath String
A X509 key to connect to OpenSearch
healthcheck Boolean
Set the client healthcheck option for the OpenSearch client. Healthchecking is designed for direct access to the cluster.
hostOverride String
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.
insecure Boolean
Disable SSL verification of API calls
opensearchVersion String
OpenSearch Version
password String
Password to use to connect to OpenSearch using basic auth
proxy String
Proxy URL to use for requests to OpenSearch.
signAwsRequests Boolean
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.
sniff Boolean
Set the node sniffing option for the OpenSearch client. Client won't work with sniffing if nodes are not routable.
token String
A bearer token or ApiKey for an Authorization header, e.g. Active Directory API key.
tokenName String
The type of token, usually ApiKey or Bearer
username String
Username to use to connect to OpenSearch using basic auth
versionPingTimeout Number
Version ping timeout in seconds

Outputs

All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Package Details

Repository
opensearch opensearch-project/terraform-provider-opensearch
License
Notes
This Pulumi package is based on the opensearch Terraform Provider.
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
opensearch-project/terraform-provider-opensearch