aws-native.opensearchservice.Domain
Explore with Pulumi AI
An example resource schema demonstrating some basic constructs and validation rules.
Create Domain Resource
new Domain(name: string, args?: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_policies: Optional[Any] = None,
advanced_options: Optional[Any] = None,
advanced_security_options: Optional[DomainAdvancedSecurityOptionsInputArgs] = None,
cluster_config: Optional[DomainClusterConfigArgs] = None,
cognito_options: Optional[DomainCognitoOptionsArgs] = None,
domain_endpoint_options: Optional[DomainEndpointOptionsArgs] = None,
domain_name: Optional[str] = None,
e_bs_options: Optional[DomainEBSOptionsArgs] = None,
encryption_at_rest_options: Optional[DomainEncryptionAtRestOptionsArgs] = None,
engine_version: Optional[str] = None,
log_publishing_options: Optional[Any] = None,
node_to_node_encryption_options: Optional[DomainNodeToNodeEncryptionOptionsArgs] = None,
off_peak_window_options: Optional[DomainOffPeakWindowOptionsArgs] = None,
snapshot_options: Optional[DomainSnapshotOptionsArgs] = None,
software_update_options: Optional[DomainSoftwareUpdateOptionsArgs] = None,
tags: Optional[Sequence[DomainTagArgs]] = None,
v_pc_options: Optional[DomainVPCOptionsArgs] = None)
@overload
def Domain(resource_name: str,
args: Optional[DomainArgs] = None,
opts: Optional[ResourceOptions] = None)
func NewDomain(ctx *Context, name string, args *DomainArgs, opts ...ResourceOption) (*Domain, error)
public Domain(string name, DomainArgs? args = null, CustomResourceOptions? opts = null)
public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)
type: aws-native:opensearchservice:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DomainArgs
- 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 DomainArgs
- 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 DomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DomainArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Domain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Domain resource accepts the following input properties:
- Access
Policies object - Advanced
Options object - Advanced
Security Pulumi.Options Aws Native. Open Search Service. Inputs. Domain Advanced Security Options Input Args - Cluster
Config Pulumi.Aws Native. Open Search Service. Inputs. Domain Cluster Config Args - Cognito
Options Pulumi.Aws Native. Open Search Service. Inputs. Domain Cognito Options Args - Domain
Endpoint Pulumi.Options Aws Native. Open Search Service. Inputs. Domain Endpoint Options Args - Domain
Name string - EBSOptions
Pulumi.
Aws Native. Open Search Service. Inputs. Domain EBSOptions Args - Encryption
At Pulumi.Rest Options Aws Native. Open Search Service. Inputs. Domain Encryption At Rest Options Args - Engine
Version string - Log
Publishing objectOptions - Node
To Pulumi.Node Encryption Options Aws Native. Open Search Service. Inputs. Domain Node To Node Encryption Options Args - Off
Peak Pulumi.Window Options Aws Native. Open Search Service. Inputs. Domain Off Peak Window Options Args - Snapshot
Options Pulumi.Aws Native. Open Search Service. Inputs. Domain Snapshot Options Args - Software
Update Pulumi.Options Aws Native. Open Search Service. Inputs. Domain Software Update Options Args - List<Pulumi.
Aws Native. Open Search Service. Inputs. Domain Tag Args> An arbitrary set of tags (key-value pairs) for this Domain.
- VPCOptions
Pulumi.
Aws Native. Open Search Service. Inputs. Domain VPCOptions Args
- Access
Policies interface{} - Advanced
Options interface{} - Advanced
Security DomainOptions Advanced Security Options Input Args - Cluster
Config DomainCluster Config Args - Cognito
Options DomainCognito Options Args - Domain
Endpoint DomainOptions Endpoint Options Args - Domain
Name string - EBSOptions
Domain
EBSOptions Args - Encryption
At DomainRest Options Encryption At Rest Options Args - Engine
Version string - Log
Publishing interface{}Options - Node
To DomainNode Encryption Options Node To Node Encryption Options Args - Off
Peak DomainWindow Options Off Peak Window Options Args - Snapshot
Options DomainSnapshot Options Args - Software
Update DomainOptions Software Update Options Args - []Domain
Tag Args An arbitrary set of tags (key-value pairs) for this Domain.
- VPCOptions
Domain
VPCOptions Args
- access
Policies Object - advanced
Options Object - advanced
Security DomainOptions Advanced Security Options Input Args - cluster
Config DomainCluster Config Args - cognito
Options DomainCognito Options Args - domain
Endpoint DomainOptions Endpoint Options Args - domain
Name String - e
BSOptions DomainEBSOptions Args - encryption
At DomainRest Options Encryption At Rest Options Args - engine
Version String - log
Publishing ObjectOptions - node
To DomainNode Encryption Options Node To Node Encryption Options Args - off
Peak DomainWindow Options Off Peak Window Options Args - snapshot
Options DomainSnapshot Options Args - software
Update DomainOptions Software Update Options Args - List<Domain
Tag Args> An arbitrary set of tags (key-value pairs) for this Domain.
- v
PCOptions DomainVPCOptions Args
- access
Policies any - advanced
Options any - advanced
Security DomainOptions Advanced Security Options Input Args - cluster
Config DomainCluster Config Args - cognito
Options DomainCognito Options Args - domain
Endpoint DomainOptions Endpoint Options Args - domain
Name string - e
BSOptions DomainEBSOptions Args - encryption
At DomainRest Options Encryption At Rest Options Args - engine
Version string - log
Publishing anyOptions - node
To DomainNode Encryption Options Node To Node Encryption Options Args - off
Peak DomainWindow Options Off Peak Window Options Args - snapshot
Options DomainSnapshot Options Args - software
Update DomainOptions Software Update Options Args - Domain
Tag Args[] An arbitrary set of tags (key-value pairs) for this Domain.
- v
PCOptions DomainVPCOptions Args
- access_
policies Any - advanced_
options Any - advanced_
security_ Domainoptions Advanced Security Options Input Args - cluster_
config DomainCluster Config Args - cognito_
options DomainCognito Options Args - domain_
endpoint_ Domainoptions Endpoint Options Args - domain_
name str - e_
bs_ Domainoptions EBSOptions Args - encryption_
at_ Domainrest_ options Encryption At Rest Options Args - engine_
version str - log_
publishing_ Anyoptions - node_
to_ Domainnode_ encryption_ options Node To Node Encryption Options Args - off_
peak_ Domainwindow_ options Off Peak Window Options Args - snapshot_
options DomainSnapshot Options Args - software_
update_ Domainoptions Software Update Options Args - Sequence[Domain
Tag Args] An arbitrary set of tags (key-value pairs) for this Domain.
- v_
pc_ Domainoptions VPCOptions Args
- access
Policies Any - advanced
Options Any - advanced
Security Property MapOptions - cluster
Config Property Map - cognito
Options Property Map - domain
Endpoint Property MapOptions - domain
Name String - e
BSOptions Property Map - encryption
At Property MapRest Options - engine
Version String - log
Publishing AnyOptions - node
To Property MapNode Encryption Options - off
Peak Property MapWindow Options - snapshot
Options Property Map - software
Update Property MapOptions - List<Property Map>
An arbitrary set of tags (key-value pairs) for this Domain.
- v
PCOptions Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:
- Arn string
- Domain
Arn string - Domain
Endpoint string - Domain
Endpoints object - Id string
The provider-assigned unique ID for this managed resource.
- Service
Software Pulumi.Options Aws Native. Open Search Service. Outputs. Domain Service Software Options
- Arn string
- Domain
Arn string - Domain
Endpoint string - Domain
Endpoints interface{} - Id string
The provider-assigned unique ID for this managed resource.
- Service
Software DomainOptions Service Software Options
- arn String
- domain
Arn String - domain
Endpoint String - domain
Endpoints Object - id String
The provider-assigned unique ID for this managed resource.
- service
Software DomainOptions Service Software Options
- arn string
- domain
Arn string - domain
Endpoint string - domain
Endpoints any - id string
The provider-assigned unique ID for this managed resource.
- service
Software DomainOptions Service Software Options
- arn str
- domain_
arn str - domain_
endpoint str - domain_
endpoints Any - id str
The provider-assigned unique ID for this managed resource.
- service_
software_ Domainoptions Service Software Options
- arn String
- domain
Arn String - domain
Endpoint String - domain
Endpoints Any - id String
The provider-assigned unique ID for this managed resource.
- service
Software Property MapOptions
Supporting Types
DomainAdvancedSecurityOptionsInput
- anonymous
Auth StringDisable Date - anonymous
Auth BooleanEnabled - enabled Boolean
- internal
User BooleanDatabase Enabled - master
User Property MapOptions - s
AMLOptions Property Map
DomainClusterConfig
- Dedicated
Master intCount - Dedicated
Master boolEnabled - Dedicated
Master stringType - Instance
Count int - Instance
Type string - Multi
AZWith boolStandby Enabled - Warm
Count int - Warm
Enabled bool - Warm
Type string - Zone
Awareness DomainConfig Zone Awareness Config - Zone
Awareness boolEnabled
- dedicated
Master IntegerCount - dedicated
Master BooleanEnabled - dedicated
Master StringType - instance
Count Integer - instance
Type String - multi
AZWith BooleanStandby Enabled - warm
Count Integer - warm
Enabled Boolean - warm
Type String - zone
Awareness DomainConfig Zone Awareness Config - zone
Awareness BooleanEnabled
- dedicated
Master numberCount - dedicated
Master booleanEnabled - dedicated
Master stringType - instance
Count number - instance
Type string - multi
AZWith booleanStandby Enabled - warm
Count number - warm
Enabled boolean - warm
Type string - zone
Awareness DomainConfig Zone Awareness Config - zone
Awareness booleanEnabled
- dedicated
Master NumberCount - dedicated
Master BooleanEnabled - dedicated
Master StringType - instance
Count Number - instance
Type String - multi
AZWith BooleanStandby Enabled - warm
Count Number - warm
Enabled Boolean - warm
Type String - zone
Awareness Property MapConfig - zone
Awareness BooleanEnabled
DomainCognitoOptions
- Enabled bool
- Identity
Pool stringId - Role
Arn string - User
Pool stringId
- Enabled bool
- Identity
Pool stringId - Role
Arn string - User
Pool stringId
- enabled Boolean
- identity
Pool StringId - role
Arn String - user
Pool StringId
- enabled boolean
- identity
Pool stringId - role
Arn string - user
Pool stringId
- enabled bool
- identity_
pool_ strid - role_
arn str - user_
pool_ strid
- enabled Boolean
- identity
Pool StringId - role
Arn String - user
Pool StringId
DomainEBSOptions
- EBSEnabled bool
- Iops int
- Throughput int
- Volume
Size int - Volume
Type string
- EBSEnabled bool
- Iops int
- Throughput int
- Volume
Size int - Volume
Type string
- e
BSEnabled Boolean - iops Integer
- throughput Integer
- volume
Size Integer - volume
Type String
- e
BSEnabled boolean - iops number
- throughput number
- volume
Size number - volume
Type string
- e_
bs_ boolenabled - iops int
- throughput int
- volume_
size int - volume_
type str
- e
BSEnabled Boolean - iops Number
- throughput Number
- volume
Size Number - volume
Type String
DomainEncryptionAtRestOptions
- enabled bool
- kms_
key_ strid
DomainEndpointOptions
- Custom
Endpoint string - Custom
Endpoint stringCertificate Arn - Custom
Endpoint boolEnabled - Enforce
HTTPS bool - TLSSecurity
Policy string
- Custom
Endpoint string - Custom
Endpoint stringCertificate Arn - Custom
Endpoint boolEnabled - Enforce
HTTPS bool - TLSSecurity
Policy string
- custom
Endpoint String - custom
Endpoint StringCertificate Arn - custom
Endpoint BooleanEnabled - enforce
HTTPS Boolean - t
LSSecurity StringPolicy
- custom
Endpoint string - custom
Endpoint stringCertificate Arn - custom
Endpoint booleanEnabled - enforce
HTTPS boolean - t
LSSecurity stringPolicy
- custom
Endpoint String - custom
Endpoint StringCertificate Arn - custom
Endpoint BooleanEnabled - enforce
HTTPS Boolean - t
LSSecurity StringPolicy
DomainIdp
- Entity
Id string - Metadata
Content string
- Entity
Id string - Metadata
Content string
- entity
Id String - metadata
Content String
- entity
Id string - metadata
Content string
- entity_
id str - metadata_
content str
- entity
Id String - metadata
Content String
DomainMasterUserOptions
- Master
User stringARN - Master
User stringName - Master
User stringPassword
- Master
User stringARN - Master
User stringName - Master
User stringPassword
- master
User StringARN - master
User StringName - master
User StringPassword
- master
User stringARN - master
User stringName - master
User stringPassword
- master
User StringARN - master
User StringName - master
User StringPassword
DomainNodeToNodeEncryptionOptions
- Enabled bool
- Enabled bool
- enabled Boolean
- enabled boolean
- enabled bool
- enabled Boolean
DomainOffPeakWindow
DomainOffPeakWindowOptions
- enabled Boolean
- off
Peak Property MapWindow
DomainSAMLOptions
- Enabled bool
- Idp
Pulumi.
Aws Native. Open Search Service. Inputs. Domain Idp - Master
Backend stringRole - Master
User stringName - Roles
Key string - Session
Timeout intMinutes - Subject
Key string
- Enabled bool
- Idp
Domain
Idp - Master
Backend stringRole - Master
User stringName - Roles
Key string - Session
Timeout intMinutes - Subject
Key string
- enabled Boolean
- idp
Domain
Idp - master
Backend StringRole - master
User StringName - roles
Key String - session
Timeout IntegerMinutes - subject
Key String
- enabled boolean
- idp
Domain
Idp - master
Backend stringRole - master
User stringName - roles
Key string - session
Timeout numberMinutes - subject
Key string
- enabled bool
- idp
Domain
Idp - master_
backend_ strrole - master_
user_ strname - roles_
key str - session_
timeout_ intminutes - subject_
key str
- enabled Boolean
- idp Property Map
- master
Backend StringRole - master
User StringName - roles
Key String - session
Timeout NumberMinutes - subject
Key String
DomainServiceSoftwareOptions
- Automated
Update stringDate - Cancellable bool
- Current
Version string - Description string
- New
Version string - Optional
Deployment bool - Update
Available bool - Update
Status string
- Automated
Update stringDate - Cancellable bool
- Current
Version string - Description string
- New
Version string - Optional
Deployment bool - Update
Available bool - Update
Status string
- automated
Update StringDate - cancellable Boolean
- current
Version String - description String
- new
Version String - optional
Deployment Boolean - update
Available Boolean - update
Status String
- automated
Update stringDate - cancellable boolean
- current
Version string - description string
- new
Version string - optional
Deployment boolean - update
Available boolean - update
Status string
- automated_
update_ strdate - cancellable bool
- current_
version str - description str
- new_
version str - optional_
deployment bool - update_
available bool - update_
status str
- automated
Update StringDate - cancellable Boolean
- current
Version String - description String
- new
Version String - optional
Deployment Boolean - update
Available Boolean - update
Status String
DomainSnapshotOptions
- automated
Snapshot IntegerStart Hour
- automated
Snapshot numberStart Hour
- automated
Snapshot NumberStart Hour
DomainSoftwareUpdateOptions
- auto
Software BooleanUpdate Enabled
- auto
Software booleanUpdate Enabled
- auto
Software BooleanUpdate Enabled
DomainTag
DomainVPCOptions
- Security
Group List<string>Ids - Subnet
Ids List<string>
- Security
Group []stringIds - Subnet
Ids []string
- security
Group List<String>Ids - subnet
Ids List<String>
- security
Group string[]Ids - subnet
Ids string[]
- security_
group_ Sequence[str]ids - subnet_
ids Sequence[str]
- security
Group List<String>Ids - subnet
Ids List<String>
DomainWindowStartTime
DomainZoneAwarenessConfig
- availability
Zone IntegerCount
- availability
Zone numberCount
- availability
Zone NumberCount
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0