AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

Domain

An example resource schema demonstrating some basic constructs and validation rules.

Create a 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,
           snapshot_options: Optional[DomainSnapshotOptionsArgs] = 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:

AccessPolicies object
AdvancedOptions object
AdvancedSecurityOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainAdvancedSecurityOptionsInputArgs
ClusterConfig Pulumi.AwsNative.OpenSearchService.Inputs.DomainClusterConfigArgs
CognitoOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainCognitoOptionsArgs
DomainEndpointOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainEndpointOptionsArgs
DomainName string
EBSOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainEBSOptionsArgs
EncryptionAtRestOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainEncryptionAtRestOptionsArgs
EngineVersion string
LogPublishingOptions object
NodeToNodeEncryptionOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainNodeToNodeEncryptionOptionsArgs
SnapshotOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainSnapshotOptionsArgs
Tags List<Pulumi.AwsNative.OpenSearchService.Inputs.DomainTagArgs>

An arbitrary set of tags (key-value pairs) for this Domain.

VPCOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainVPCOptionsArgs

Outputs

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

Arn string
DomainArn string
DomainEndpoint string
DomainEndpoints object
Id string

The provider-assigned unique ID for this managed resource.

ServiceSoftwareOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainServiceSoftwareOptions
Arn string
DomainArn string
DomainEndpoint string
DomainEndpoints interface{}
Id string

The provider-assigned unique ID for this managed resource.

ServiceSoftwareOptions DomainServiceSoftwareOptions
arn String
domainArn String
domainEndpoint String
domainEndpoints Object
id String

The provider-assigned unique ID for this managed resource.

serviceSoftwareOptions DomainServiceSoftwareOptions
arn string
domainArn string
domainEndpoint string
domainEndpoints any
id string

The provider-assigned unique ID for this managed resource.

serviceSoftwareOptions DomainServiceSoftwareOptions
arn str
domain_arn str
domain_endpoint str
domain_endpoints Any
id str

The provider-assigned unique ID for this managed resource.

service_software_options DomainServiceSoftwareOptions
arn String
domainArn String
domainEndpoint String
domainEndpoints Any
id String

The provider-assigned unique ID for this managed resource.

serviceSoftwareOptions Property Map

Supporting Types

DomainAdvancedSecurityOptionsInput

DomainClusterConfig

DomainCognitoOptions

Enabled bool
IdentityPoolId string
RoleArn string
UserPoolId string
Enabled bool
IdentityPoolId string
RoleArn string
UserPoolId string
enabled Boolean
identityPoolId String
roleArn String
userPoolId String
enabled boolean
identityPoolId string
roleArn string
userPoolId string
enabled Boolean
identityPoolId String
roleArn String
userPoolId String

DomainEBSOptions

eBSEnabled Boolean
iops Integer
volumeSize Integer
volumeType String
eBSEnabled boolean
iops number
volumeSize number
volumeType string
eBSEnabled Boolean
iops Number
volumeSize Number
volumeType String

DomainEncryptionAtRestOptions

Enabled bool
KmsKeyId string
Enabled bool
KmsKeyId string
enabled Boolean
kmsKeyId String
enabled boolean
kmsKeyId string
enabled Boolean
kmsKeyId String

DomainEndpointOptions

DomainMasterUserOptions

DomainNodeToNodeEncryptionOptions

Enabled bool
Enabled bool
enabled Boolean
enabled boolean
enabled bool
enabled Boolean

DomainServiceSoftwareOptions

DomainSnapshotOptions

DomainTag

Key string

The value of the tag.

Value string

The key of the tag.

Key string

The value of the tag.

Value string

The key of the tag.

key String

The value of the tag.

value String

The key of the tag.

key string

The value of the tag.

value string

The key of the tag.

key str

The value of the tag.

value str

The key of the tag.

key String

The value of the tag.

value String

The key of the tag.

DomainVPCOptions

SecurityGroupIds List<string>
SubnetIds List<string>
SecurityGroupIds []string
SubnetIds []string
securityGroupIds List<String>
subnetIds List<String>
securityGroupIds string[]
subnetIds string[]
security_group_ids Sequence[str]
subnet_ids Sequence[str]
securityGroupIds List<String>
subnetIds List<String>

DomainZoneAwarenessConfig

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0