1. Packages
  2. AWS Native
  3. API Docs
  4. opensearchservice
  5. Domain

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.90.0 published on Monday, Dec 4, 2023 by Pulumi

aws-native.opensearchservice.Domain

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.90.0 published on Monday, Dec 4, 2023 by Pulumi

    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,
               ebs_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,
               vpc_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.DomainAdvancedSecurityOptionsInput
    ClusterConfig Pulumi.AwsNative.OpenSearchService.Inputs.DomainClusterConfig
    CognitoOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainCognitoOptions
    DomainEndpointOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainEndpointOptions
    DomainName string
    EbsOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainEbsOptions
    EncryptionAtRestOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainEncryptionAtRestOptions
    EngineVersion string
    LogPublishingOptions object
    NodeToNodeEncryptionOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainNodeToNodeEncryptionOptions
    OffPeakWindowOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainOffPeakWindowOptions
    SnapshotOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainSnapshotOptions
    SoftwareUpdateOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainSoftwareUpdateOptions
    Tags List<Pulumi.AwsNative.OpenSearchService.Inputs.DomainTag>

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

    VpcOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainVpcOptions

    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, DomainAdvancedSecurityOptionsInputArgs

    DomainClusterConfig, DomainClusterConfigArgs

    DomainCognitoOptions, DomainCognitoOptionsArgs

    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, DomainEbsOptionsArgs

    ebsEnabled Boolean
    iops Integer
    throughput Integer
    volumeSize Integer
    volumeType String
    ebsEnabled boolean
    iops number
    throughput number
    volumeSize number
    volumeType string
    ebsEnabled Boolean
    iops Number
    throughput Number
    volumeSize Number
    volumeType String

    DomainEncryptionAtRestOptions, DomainEncryptionAtRestOptionsArgs

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

    DomainEndpointOptions, DomainEndpointOptionsArgs

    DomainIdp, DomainIdpArgs

    DomainMasterUserOptions, DomainMasterUserOptionsArgs

    DomainNodeToNodeEncryptionOptions, DomainNodeToNodeEncryptionOptionsArgs

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

    DomainOffPeakWindow, DomainOffPeakWindowArgs

    DomainOffPeakWindowOptions, DomainOffPeakWindowOptionsArgs

    DomainSamlOptions, DomainSamlOptionsArgs

    DomainServiceSoftwareOptions, DomainServiceSoftwareOptionsArgs

    DomainSnapshotOptions, DomainSnapshotOptionsArgs

    DomainSoftwareUpdateOptions, DomainSoftwareUpdateOptionsArgs

    DomainTag, DomainTagArgs

    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, DomainVpcOptionsArgs

    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>

    DomainWindowStartTime, DomainWindowStartTimeArgs

    Hours int
    Minutes int
    Hours int
    Minutes int
    hours Integer
    minutes Integer
    hours number
    minutes number
    hours int
    minutes int
    hours Number
    minutes Number

    DomainZoneAwarenessConfig, DomainZoneAwarenessConfigArgs

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.90.0 published on Monday, Dec 4, 2023 by Pulumi