Module elasticsearch

@pulumi/aws > elasticsearch

Index

• class Domain
• class DomainPolicy
• interface DomainArgs
• interface DomainPolicyArgs
• interface DomainPolicyState
• interface DomainState

elasticsearch/domain.ts elasticsearch/domainPolicy.ts

class Domain

constructor

new Domain(name: string, args?: DomainArgs, opts?: pulumi.CustomResourceOptions)

Create a Domain resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainState): Domain

Get an existing Domain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessPolicies

public accessPolicies: pulumi.Output<string>;

IAM policy document specifying the access policies for the domain

property advancedOptions

public advancedOptions: pulumi.Output<{ ... }>;

Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing Terraform to want to recreate your Elasticsearch domain on every apply.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the domain.

property clusterConfig

public clusterConfig: pulumi.Output<{ ... }>;

Cluster configuration of the domain, see below.

property cognitoOptions

public cognitoOptions: pulumi.Output<{ ... } | undefined>;

property domainId

public domainId: pulumi.Output<string>;

Unique identifier for the domain.

property domainName

public domainName: pulumi.Output<string>;

Name of the domain.

property ebsOptions

public ebsOptions: pulumi.Output<{ ... }>;

EBS related options, may be required based on chosen instance size. See below.

property elasticsearchVersion

public elasticsearchVersion: pulumi.Output<string | undefined>;

The version of ElasticSearch to deploy. Defaults to 1.5

property encryptAtRest

public encryptAtRest: pulumi.Output<{ ... }>;

Encrypt at rest options. Only available for certain instance types. See below.

property endpoint

public endpoint: pulumi.Output<string>;

Domain-specific endpoint used to submit index, search, and data upload requests.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kibanaEndpoint

public kibanaEndpoint: pulumi.Output<string>;

Domain-specific endpoint for kibana without https scheme.

• vpc_options.0.availability_zones - If the domain was created inside a VPC, the names of the availability zones the configured subnet_ids were created inside.
• vpc_options.0.vpc_id - If the domain was created inside a VPC, the ID of the VPC.

property logPublishingOptions

public logPublishingOptions: pulumi.Output<{ ... }[] | undefined>;

Options for publishing slow logs to CloudWatch Logs.

property snapshotOptions

public snapshotOptions: pulumi.Output<{ ... } | undefined>;

Snapshot related options, see below.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcOptions

public vpcOptions: pulumi.Output<{ ... } | undefined>;

VPC related options, see below. Adding or removing this configuration forces a new resource (documentation).

class DomainPolicy

Allows setting policy to an ElasticSearch domain while referencing domain attributes (e.g. ARN)

constructor

new DomainPolicy(name: string, args: DomainPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a DomainPolicy resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainPolicyState): DomainPolicy

Get an existing DomainPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessPolicies

public accessPolicies: pulumi.Output<string>;

IAM policy document specifying the access policies for the domain

property domainName

public domainName: pulumi.Output<string>;

Name of the domain.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface DomainArgs

The set of arguments for constructing a Domain resource.

property accessPolicies

accessPolicies?: pulumi.Input<string>;

IAM policy document specifying the access policies for the domain

property advancedOptions

advancedOptions?: pulumi.Input<{ ... }>;

Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing Terraform to want to recreate your Elasticsearch domain on every apply.

property clusterConfig

clusterConfig?: pulumi.Input<{ ... }>;

Cluster configuration of the domain, see below.

property cognitoOptions

cognitoOptions?: pulumi.Input<{ ... }>;

property domainName

domainName?: pulumi.Input<string>;

Name of the domain.

property ebsOptions

ebsOptions?: pulumi.Input<{ ... }>;

EBS related options, may be required based on chosen instance size. See below.

property elasticsearchVersion

elasticsearchVersion?: pulumi.Input<string>;

The version of ElasticSearch to deploy. Defaults to 1.5

property encryptAtRest

encryptAtRest?: pulumi.Input<{ ... }>;

Encrypt at rest options. Only available for certain instance types. See below.

property logPublishingOptions

logPublishingOptions?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Options for publishing slow logs to CloudWatch Logs.

property snapshotOptions

snapshotOptions?: pulumi.Input<{ ... }>;

Snapshot related options, see below.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource

property vpcOptions

vpcOptions?: pulumi.Input<{ ... }>;

VPC related options, see below. Adding or removing this configuration forces a new resource (documentation).

interface DomainPolicyArgs

The set of arguments for constructing a DomainPolicy resource.

property accessPolicies

accessPolicies: pulumi.Input<string>;

IAM policy document specifying the access policies for the domain

property domainName

domainName: pulumi.Input<string>;

Name of the domain.

interface DomainPolicyState

Input properties used for looking up and filtering DomainPolicy resources.

property accessPolicies

accessPolicies?: pulumi.Input<string>;

IAM policy document specifying the access policies for the domain

property domainName

domainName?: pulumi.Input<string>;

Name of the domain.

interface DomainState

Input properties used for looking up and filtering Domain resources.

property accessPolicies

accessPolicies?: pulumi.Input<string>;

IAM policy document specifying the access policies for the domain

property advancedOptions

advancedOptions?: pulumi.Input<{ ... }>;

Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing Terraform to want to recreate your Elasticsearch domain on every apply.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the domain.

property clusterConfig

clusterConfig?: pulumi.Input<{ ... }>;

Cluster configuration of the domain, see below.

property cognitoOptions

cognitoOptions?: pulumi.Input<{ ... }>;

property domainId

domainId?: pulumi.Input<string>;

Unique identifier for the domain.

property domainName

domainName?: pulumi.Input<string>;

Name of the domain.

property ebsOptions

ebsOptions?: pulumi.Input<{ ... }>;

EBS related options, may be required based on chosen instance size. See below.

property elasticsearchVersion

elasticsearchVersion?: pulumi.Input<string>;

The version of ElasticSearch to deploy. Defaults to 1.5

property encryptAtRest

encryptAtRest?: pulumi.Input<{ ... }>;

Encrypt at rest options. Only available for certain instance types. See below.

property endpoint

endpoint?: pulumi.Input<string>;

Domain-specific endpoint used to submit index, search, and data upload requests.

property kibanaEndpoint

kibanaEndpoint?: pulumi.Input<string>;

Domain-specific endpoint for kibana without https scheme.

• vpc_options.0.availability_zones - If the domain was created inside a VPC, the names of the availability zones the configured subnet_ids were created inside.
• vpc_options.0.vpc_id - If the domain was created inside a VPC, the ID of the VPC.

property logPublishingOptions

logPublishingOptions?: pulumi.Input<pulumi.Input<{ ... }>[]>;

Options for publishing slow logs to CloudWatch Logs.

property snapshotOptions

snapshotOptions?: pulumi.Input<{ ... }>;

Snapshot related options, see below.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource

property vpcOptions

vpcOptions?: pulumi.Input<{ ... }>;

VPC related options, see below. Adding or removing this configuration forces a new resource (documentation).