elasticstack.ElasticsearchClusterSettings
Explore with Pulumi AI
Updates cluster-wide settings. If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticsearchClusterSettings;
import com.pulumi.elasticstack.ElasticsearchClusterSettingsArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchClusterSettingsPersistentArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchClusterSettingsTransientArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myClusterSettings = new ElasticsearchClusterSettings("myClusterSettings", ElasticsearchClusterSettingsArgs.builder()
.persistent(ElasticsearchClusterSettingsPersistentArgs.builder()
.settings(
ElasticsearchClusterSettingsPersistentSettingArgs.builder()
.name("indices.lifecycle.poll_interval")
.value("10m")
.build(),
ElasticsearchClusterSettingsPersistentSettingArgs.builder()
.name("indices.recovery.max_bytes_per_sec")
.value("50mb")
.build(),
ElasticsearchClusterSettingsPersistentSettingArgs.builder()
.name("indices.breaker.total.limit")
.value("65%")
.build(),
ElasticsearchClusterSettingsPersistentSettingArgs.builder()
.name("xpack.security.audit.logfile.events.include")
.valueList(
"ACCESS_DENIED",
"ACCESS_GRANTED")
.build())
.build())
.transient_(ElasticsearchClusterSettingsTransientArgs.builder()
.settings(ElasticsearchClusterSettingsTransientSettingArgs.builder()
.name("indices.breaker.total.limit")
.value("60%")
.build())
.build())
.build());
}
}
resources:
myClusterSettings:
type: elasticstack:ElasticsearchClusterSettings
properties:
persistent:
settings:
- name: indices.lifecycle.poll_interval
value: 10m
- name: indices.recovery.max_bytes_per_sec
value: 50mb
- name: indices.breaker.total.limit
value: 65%
- name: xpack.security.audit.logfile.events.include
valueList:
- ACCESS_DENIED
- ACCESS_GRANTED
transient:
settings:
- name: indices.breaker.total.limit
value: 60%
Create ElasticsearchClusterSettings Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ElasticsearchClusterSettings(name: string, args?: ElasticsearchClusterSettingsArgs, opts?: CustomResourceOptions);
@overload
def ElasticsearchClusterSettings(resource_name: str,
args: Optional[ElasticsearchClusterSettingsArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ElasticsearchClusterSettings(resource_name: str,
opts: Optional[ResourceOptions] = None,
elasticsearch_connection: Optional[ElasticsearchClusterSettingsElasticsearchConnectionArgs] = None,
persistent: Optional[ElasticsearchClusterSettingsPersistentArgs] = None,
transient: Optional[ElasticsearchClusterSettingsTransientArgs] = None)
func NewElasticsearchClusterSettings(ctx *Context, name string, args *ElasticsearchClusterSettingsArgs, opts ...ResourceOption) (*ElasticsearchClusterSettings, error)
public ElasticsearchClusterSettings(string name, ElasticsearchClusterSettingsArgs? args = null, CustomResourceOptions? opts = null)
public ElasticsearchClusterSettings(String name, ElasticsearchClusterSettingsArgs args)
public ElasticsearchClusterSettings(String name, ElasticsearchClusterSettingsArgs args, CustomResourceOptions options)
type: elasticstack:ElasticsearchClusterSettings
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ElasticsearchClusterSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ElasticsearchClusterSettingsArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ElasticsearchClusterSettingsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ElasticsearchClusterSettingsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ElasticsearchClusterSettingsArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var elasticsearchClusterSettingsResource = new Elasticstack.ElasticsearchClusterSettings("elasticsearchClusterSettingsResource", new()
{
Persistent = new Elasticstack.Inputs.ElasticsearchClusterSettingsPersistentArgs
{
Settings = new[]
{
new Elasticstack.Inputs.ElasticsearchClusterSettingsPersistentSettingArgs
{
Name = "string",
Value = "string",
ValueLists = new[]
{
"string",
},
},
},
},
Transient = new Elasticstack.Inputs.ElasticsearchClusterSettingsTransientArgs
{
Settings = new[]
{
new Elasticstack.Inputs.ElasticsearchClusterSettingsTransientSettingArgs
{
Name = "string",
Value = "string",
ValueLists = new[]
{
"string",
},
},
},
},
});
example, err := elasticstack.NewElasticsearchClusterSettings(ctx, "elasticsearchClusterSettingsResource", &elasticstack.ElasticsearchClusterSettingsArgs{
Persistent: &elasticstack.ElasticsearchClusterSettingsPersistentArgs{
Settings: elasticstack.ElasticsearchClusterSettingsPersistentSettingArray{
&elasticstack.ElasticsearchClusterSettingsPersistentSettingArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
ValueLists: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
Transient: &elasticstack.ElasticsearchClusterSettingsTransientArgs{
Settings: elasticstack.ElasticsearchClusterSettingsTransientSettingArray{
&elasticstack.ElasticsearchClusterSettingsTransientSettingArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
ValueLists: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
})
var elasticsearchClusterSettingsResource = new ElasticsearchClusterSettings("elasticsearchClusterSettingsResource", ElasticsearchClusterSettingsArgs.builder()
.persistent(ElasticsearchClusterSettingsPersistentArgs.builder()
.settings(ElasticsearchClusterSettingsPersistentSettingArgs.builder()
.name("string")
.value("string")
.valueLists("string")
.build())
.build())
.transient_(ElasticsearchClusterSettingsTransientArgs.builder()
.settings(ElasticsearchClusterSettingsTransientSettingArgs.builder()
.name("string")
.value("string")
.valueLists("string")
.build())
.build())
.build());
elasticsearch_cluster_settings_resource = elasticstack.ElasticsearchClusterSettings("elasticsearchClusterSettingsResource",
persistent={
"settings": [{
"name": "string",
"value": "string",
"value_lists": ["string"],
}],
},
transient={
"settings": [{
"name": "string",
"value": "string",
"value_lists": ["string"],
}],
})
const elasticsearchClusterSettingsResource = new elasticstack.ElasticsearchClusterSettings("elasticsearchClusterSettingsResource", {
persistent: {
settings: [{
name: "string",
value: "string",
valueLists: ["string"],
}],
},
transient: {
settings: [{
name: "string",
value: "string",
valueLists: ["string"],
}],
},
});
type: elasticstack:ElasticsearchClusterSettings
properties:
persistent:
settings:
- name: string
value: string
valueLists:
- string
transient:
settings:
- name: string
value: string
valueLists:
- string
ElasticsearchClusterSettings 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 ElasticsearchClusterSettings resource accepts the following input properties:
- Elasticsearch
Connection ElasticsearchCluster Settings Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- Persistent
Elasticsearch
Cluster Settings Persistent - Settings will apply across restarts.
- Transient
Elasticsearch
Cluster Settings Transient - Settings do not survive a full cluster restart.
- Elasticsearch
Connection ElasticsearchCluster Settings Elasticsearch Connection Args - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- Persistent
Elasticsearch
Cluster Settings Persistent Args - Settings will apply across restarts.
- Transient
Elasticsearch
Cluster Settings Transient Args - Settings do not survive a full cluster restart.
- elasticsearch
Connection ElasticsearchCluster Settings Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- persistent
Elasticsearch
Cluster Settings Persistent - Settings will apply across restarts.
- transient_
Elasticsearch
Cluster Settings Transient - Settings do not survive a full cluster restart.
- elasticsearch
Connection ElasticsearchCluster Settings Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- persistent
Elasticsearch
Cluster Settings Persistent - Settings will apply across restarts.
- transient
Elasticsearch
Cluster Settings Transient - Settings do not survive a full cluster restart.
- elasticsearch_
connection ElasticsearchCluster Settings Elasticsearch Connection Args - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- persistent
Elasticsearch
Cluster Settings Persistent Args - Settings will apply across restarts.
- transient
Elasticsearch
Cluster Settings Transient Args - Settings do not survive a full cluster restart.
- elasticsearch
Connection Property Map - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- persistent Property Map
- Settings will apply across restarts.
- transient Property Map
- Settings do not survive a full cluster restart.
Outputs
All input properties are implicitly available as output properties. Additionally, the ElasticsearchClusterSettings 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.
Look up Existing ElasticsearchClusterSettings Resource
Get an existing ElasticsearchClusterSettings resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ElasticsearchClusterSettingsState, opts?: CustomResourceOptions): ElasticsearchClusterSettings
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
elasticsearch_connection: Optional[ElasticsearchClusterSettingsElasticsearchConnectionArgs] = None,
persistent: Optional[ElasticsearchClusterSettingsPersistentArgs] = None,
transient: Optional[ElasticsearchClusterSettingsTransientArgs] = None) -> ElasticsearchClusterSettings
func GetElasticsearchClusterSettings(ctx *Context, name string, id IDInput, state *ElasticsearchClusterSettingsState, opts ...ResourceOption) (*ElasticsearchClusterSettings, error)
public static ElasticsearchClusterSettings Get(string name, Input<string> id, ElasticsearchClusterSettingsState? state, CustomResourceOptions? opts = null)
public static ElasticsearchClusterSettings get(String name, Output<String> id, ElasticsearchClusterSettingsState state, CustomResourceOptions options)
resources: _: type: elasticstack:ElasticsearchClusterSettings get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Elasticsearch
Connection ElasticsearchCluster Settings Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- Persistent
Elasticsearch
Cluster Settings Persistent - Settings will apply across restarts.
- Transient
Elasticsearch
Cluster Settings Transient - Settings do not survive a full cluster restart.
- Elasticsearch
Connection ElasticsearchCluster Settings Elasticsearch Connection Args - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- Persistent
Elasticsearch
Cluster Settings Persistent Args - Settings will apply across restarts.
- Transient
Elasticsearch
Cluster Settings Transient Args - Settings do not survive a full cluster restart.
- elasticsearch
Connection ElasticsearchCluster Settings Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- persistent
Elasticsearch
Cluster Settings Persistent - Settings will apply across restarts.
- transient_
Elasticsearch
Cluster Settings Transient - Settings do not survive a full cluster restart.
- elasticsearch
Connection ElasticsearchCluster Settings Elasticsearch Connection - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- persistent
Elasticsearch
Cluster Settings Persistent - Settings will apply across restarts.
- transient
Elasticsearch
Cluster Settings Transient - Settings do not survive a full cluster restart.
- elasticsearch_
connection ElasticsearchCluster Settings Elasticsearch Connection Args - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- persistent
Elasticsearch
Cluster Settings Persistent Args - Settings will apply across restarts.
- transient
Elasticsearch
Cluster Settings Transient Args - Settings do not survive a full cluster restart.
- elasticsearch
Connection Property Map - Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.
- persistent Property Map
- Settings will apply across restarts.
- transient Property Map
- Settings do not survive a full cluster restart.
Supporting Types
ElasticsearchClusterSettingsElasticsearchConnection, ElasticsearchClusterSettingsElasticsearchConnectionArgs
- Api
Key string - API Key to use for authentication to Elasticsearch
- Bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- Ca
Data string - PEM-encoded custom Certificate Authority certificate
- Ca
File string - Path to a custom Certificate Authority certificate
- Cert
Data string - PEM encoded certificate for client auth
- Cert
File string - Path to a file containing the PEM encoded certificate for client auth
- Endpoints List<string>
- Es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- Insecure bool
- Disable TLS certificate validation
- Key
Data string - PEM encoded private key for client auth
- Key
File string - Path to a file containing the PEM encoded private key for client auth
- Password string
- Password to use for API authentication to Elasticsearch.
- Username string
- Username to use for API authentication to Elasticsearch.
- Api
Key string - API Key to use for authentication to Elasticsearch
- Bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- Ca
Data string - PEM-encoded custom Certificate Authority certificate
- Ca
File string - Path to a custom Certificate Authority certificate
- Cert
Data string - PEM encoded certificate for client auth
- Cert
File string - Path to a file containing the PEM encoded certificate for client auth
- Endpoints []string
- Es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- Insecure bool
- Disable TLS certificate validation
- Key
Data string - PEM encoded private key for client auth
- Key
File string - Path to a file containing the PEM encoded private key for client auth
- Password string
- Password to use for API authentication to Elasticsearch.
- Username string
- Username to use for API authentication to Elasticsearch.
- api
Key String - API Key to use for authentication to Elasticsearch
- bearer
Token String - Bearer Token to use for authentication to Elasticsearch
- ca
Data String - PEM-encoded custom Certificate Authority certificate
- ca
File String - Path to a custom Certificate Authority certificate
- cert
Data String - PEM encoded certificate for client auth
- cert
File String - Path to a file containing the PEM encoded certificate for client auth
- endpoints List<String>
- es
Client StringAuthentication - ES Client Authentication field to be used with the JWT token
- insecure Boolean
- Disable TLS certificate validation
- key
Data String - PEM encoded private key for client auth
- key
File String - Path to a file containing the PEM encoded private key for client auth
- password String
- Password to use for API authentication to Elasticsearch.
- username String
- Username to use for API authentication to Elasticsearch.
- api
Key string - API Key to use for authentication to Elasticsearch
- bearer
Token string - Bearer Token to use for authentication to Elasticsearch
- ca
Data string - PEM-encoded custom Certificate Authority certificate
- ca
File string - Path to a custom Certificate Authority certificate
- cert
Data string - PEM encoded certificate for client auth
- cert
File string - Path to a file containing the PEM encoded certificate for client auth
- endpoints string[]
- es
Client stringAuthentication - ES Client Authentication field to be used with the JWT token
- insecure boolean
- Disable TLS certificate validation
- key
Data string - PEM encoded private key for client auth
- key
File string - Path to a file containing the PEM encoded private key for client auth
- password string
- Password to use for API authentication to Elasticsearch.
- username string
- Username to use for API authentication to Elasticsearch.
- api_
key str - API Key to use for authentication to Elasticsearch
- bearer_
token str - Bearer Token to use for authentication to Elasticsearch
- ca_
data str - PEM-encoded custom Certificate Authority certificate
- ca_
file str - Path to a custom Certificate Authority certificate
- cert_
data str - PEM encoded certificate for client auth
- cert_
file str - Path to a file containing the PEM encoded certificate for client auth
- endpoints Sequence[str]
- es_
client_ strauthentication - ES Client Authentication field to be used with the JWT token
- insecure bool
- Disable TLS certificate validation
- key_
data str - PEM encoded private key for client auth
- key_
file str - Path to a file containing the PEM encoded private key for client auth
- password str
- Password to use for API authentication to Elasticsearch.
- username str
- Username to use for API authentication to Elasticsearch.
- api
Key String - API Key to use for authentication to Elasticsearch
- bearer
Token String - Bearer Token to use for authentication to Elasticsearch
- ca
Data String - PEM-encoded custom Certificate Authority certificate
- ca
File String - Path to a custom Certificate Authority certificate
- cert
Data String - PEM encoded certificate for client auth
- cert
File String - Path to a file containing the PEM encoded certificate for client auth
- endpoints List<String>
- es
Client StringAuthentication - ES Client Authentication field to be used with the JWT token
- insecure Boolean
- Disable TLS certificate validation
- key
Data String - PEM encoded private key for client auth
- key
File String - Path to a file containing the PEM encoded private key for client auth
- password String
- Password to use for API authentication to Elasticsearch.
- username String
- Username to use for API authentication to Elasticsearch.
ElasticsearchClusterSettingsPersistent, ElasticsearchClusterSettingsPersistentArgs
- Settings
List<Elasticsearch
Cluster Settings Persistent Setting> - Defines the setting in the cluster.
- Settings
[]Elasticsearch
Cluster Settings Persistent Setting - Defines the setting in the cluster.
- settings
List<Elasticsearch
Cluster Settings Persistent Setting> - Defines the setting in the cluster.
- settings
Elasticsearch
Cluster Settings Persistent Setting[] - Defines the setting in the cluster.
- settings
Sequence[Elasticsearch
Cluster Settings Persistent Setting] - Defines the setting in the cluster.
- settings List<Property Map>
- Defines the setting in the cluster.
ElasticsearchClusterSettingsPersistentSetting, ElasticsearchClusterSettingsPersistentSettingArgs
- Name string
- The name of the setting to set and track.
- Value string
- The value of the setting to set and track.
- Value
Lists List<string> - The list of values to be set for the key, where the list is required.
- Name string
- The name of the setting to set and track.
- Value string
- The value of the setting to set and track.
- Value
Lists []string - The list of values to be set for the key, where the list is required.
- name String
- The name of the setting to set and track.
- value String
- The value of the setting to set and track.
- value
Lists List<String> - The list of values to be set for the key, where the list is required.
- name string
- The name of the setting to set and track.
- value string
- The value of the setting to set and track.
- value
Lists string[] - The list of values to be set for the key, where the list is required.
- name str
- The name of the setting to set and track.
- value str
- The value of the setting to set and track.
- value_
lists Sequence[str] - The list of values to be set for the key, where the list is required.
- name String
- The name of the setting to set and track.
- value String
- The value of the setting to set and track.
- value
Lists List<String> - The list of values to be set for the key, where the list is required.
ElasticsearchClusterSettingsTransient, ElasticsearchClusterSettingsTransientArgs
- Settings
List<Elasticsearch
Cluster Settings Transient Setting> - Defines the setting in the cluster.
- Settings
[]Elasticsearch
Cluster Settings Transient Setting - Defines the setting in the cluster.
- settings
List<Elasticsearch
Cluster Settings Transient Setting> - Defines the setting in the cluster.
- settings
Elasticsearch
Cluster Settings Transient Setting[] - Defines the setting in the cluster.
- settings
Sequence[Elasticsearch
Cluster Settings Transient Setting] - Defines the setting in the cluster.
- settings List<Property Map>
- Defines the setting in the cluster.
ElasticsearchClusterSettingsTransientSetting, ElasticsearchClusterSettingsTransientSettingArgs
- Name string
- The name of the setting to set and track.
- Value string
- The value of the setting to set and track.
- Value
Lists List<string> - The list of values to be set for the key, where the list is required.
- Name string
- The name of the setting to set and track.
- Value string
- The value of the setting to set and track.
- Value
Lists []string - The list of values to be set for the key, where the list is required.
- name String
- The name of the setting to set and track.
- value String
- The value of the setting to set and track.
- value
Lists List<String> - The list of values to be set for the key, where the list is required.
- name string
- The name of the setting to set and track.
- value string
- The value of the setting to set and track.
- value
Lists string[] - The list of values to be set for the key, where the list is required.
- name str
- The name of the setting to set and track.
- value str
- The value of the setting to set and track.
- value_
lists Sequence[str] - The list of values to be set for the key, where the list is required.
- name String
- The name of the setting to set and track.
- value String
- The value of the setting to set and track.
- value
Lists List<String> - The list of values to be set for the key, where the list is required.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstack
Terraform Provider.