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.100.0 published on Wednesday, Mar 27, 2024 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.100.0 published on Wednesday, Mar 27, 2024 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[Mapping[str, str]] = 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,
               ip_address_type: Optional[str] = None,
               log_publishing_options: Optional[Mapping[str, DomainLogPublishingOptionArgs]] = 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[_root_inputs.TagArgs]] = 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
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    AdvancedOptions Dictionary<string, string>
    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
    IpAddressType string
    LogPublishingOptions Dictionary<string, Pulumi.AwsNative.OpenSearchService.Inputs.DomainLogPublishingOptionArgs>
    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.Inputs.Tag>
    An arbitrary set of tags (key-value pairs) for this Domain.
    VpcOptions Pulumi.AwsNative.OpenSearchService.Inputs.DomainVpcOptions
    AccessPolicies interface{}
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    AdvancedOptions map[string]string
    AdvancedSecurityOptions DomainAdvancedSecurityOptionsInputArgs
    ClusterConfig DomainClusterConfigArgs
    CognitoOptions DomainCognitoOptionsArgs
    DomainEndpointOptions DomainEndpointOptionsArgs
    DomainName string
    EbsOptions DomainEbsOptionsArgs
    EncryptionAtRestOptions DomainEncryptionAtRestOptionsArgs
    EngineVersion string
    IpAddressType string
    LogPublishingOptions map[string]DomainLogPublishingOptionArgs
    NodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptionsArgs
    OffPeakWindowOptions DomainOffPeakWindowOptionsArgs
    SnapshotOptions DomainSnapshotOptionsArgs
    SoftwareUpdateOptions DomainSoftwareUpdateOptionsArgs
    Tags TagArgs
    An arbitrary set of tags (key-value pairs) for this Domain.
    VpcOptions DomainVpcOptionsArgs
    accessPolicies Object
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    advancedOptions Map<String,String>
    advancedSecurityOptions DomainAdvancedSecurityOptionsInput
    clusterConfig DomainClusterConfig
    cognitoOptions DomainCognitoOptions
    domainEndpointOptions DomainEndpointOptions
    domainName String
    ebsOptions DomainEbsOptions
    encryptionAtRestOptions DomainEncryptionAtRestOptions
    engineVersion String
    ipAddressType String
    logPublishingOptions Map<String,DomainLogPublishingOptionArgs>
    nodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptions
    offPeakWindowOptions DomainOffPeakWindowOptions
    snapshotOptions DomainSnapshotOptions
    softwareUpdateOptions DomainSoftwareUpdateOptions
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this Domain.
    vpcOptions DomainVpcOptions
    accessPolicies any
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    advancedOptions {[key: string]: string}
    advancedSecurityOptions DomainAdvancedSecurityOptionsInput
    clusterConfig DomainClusterConfig
    cognitoOptions DomainCognitoOptions
    domainEndpointOptions DomainEndpointOptions
    domainName string
    ebsOptions DomainEbsOptions
    encryptionAtRestOptions DomainEncryptionAtRestOptions
    engineVersion string
    ipAddressType string
    logPublishingOptions {[key: string]: DomainLogPublishingOptionArgs}
    nodeToNodeEncryptionOptions DomainNodeToNodeEncryptionOptions
    offPeakWindowOptions DomainOffPeakWindowOptions
    snapshotOptions DomainSnapshotOptions
    softwareUpdateOptions DomainSoftwareUpdateOptions
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this Domain.
    vpcOptions DomainVpcOptions
    access_policies Any
    Search the CloudFormation User Guide for AWS::OpenSearchService::Domain for more information about the expected schema for this property.
    advanced_options Mapping[str, str]
    advanced_security_options DomainAdvancedSecurityOptionsInputArgs
    cluster_config DomainClusterConfigArgs
    cognito_options DomainCognitoOptionsArgs
    domain_endpoint_options DomainEndpointOptionsArgs
    domain_name str
    ebs_options DomainEbsOptionsArgs
    encryption_at_rest_options DomainEncryptionAtRestOptionsArgs
    engine_version str
    ip_address_type str
    log_publishing_options Mapping[str, DomainLogPublishingOptionArgs]
    node_to_node_encryption_options DomainNodeToNodeEncryptionOptionsArgs
    off_peak_window_options DomainOffPeakWindowOptionsArgs
    snapshot_options DomainSnapshotOptionsArgs
    software_update_options DomainSoftwareUpdateOptionsArgs
    tags TagArgs]
    An arbitrary set of tags (key-value pairs) for this Domain.
    vpc_options DomainVpcOptionsArgs

    Outputs

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

    Arn string
    AwsId string
    DomainArn string
    DomainEndpoint string
    DomainEndpointV2 string
    DomainEndpoints Dictionary<string, string>
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceSoftwareOptions Pulumi.AwsNative.OpenSearchService.Outputs.DomainServiceSoftwareOptions
    Arn string
    AwsId string
    DomainArn string
    DomainEndpoint string
    DomainEndpointV2 string
    DomainEndpoints map[string]string
    Id string
    The provider-assigned unique ID for this managed resource.
    ServiceSoftwareOptions DomainServiceSoftwareOptions
    arn String
    awsId String
    domainArn String
    domainEndpoint String
    domainEndpointV2 String
    domainEndpoints Map<String,String>
    id String
    The provider-assigned unique ID for this managed resource.
    serviceSoftwareOptions DomainServiceSoftwareOptions
    arn string
    awsId string
    domainArn string
    domainEndpoint string
    domainEndpointV2 string
    domainEndpoints {[key: string]: string}
    id string
    The provider-assigned unique ID for this managed resource.
    serviceSoftwareOptions DomainServiceSoftwareOptions
    arn str
    aws_id str
    domain_arn str
    domain_endpoint str
    domain_endpoint_v2 str
    domain_endpoints Mapping[str, str]
    id str
    The provider-assigned unique ID for this managed resource.
    service_software_options DomainServiceSoftwareOptions
    arn String
    awsId String
    domainArn String
    domainEndpoint String
    domainEndpointV2 String
    domainEndpoints Map<String>
    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

    DomainColdStorageOptions, DomainColdStorageOptionsArgs

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

    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

    DomainLogPublishingOption, DomainLogPublishingOptionArgs

    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

    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

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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.100.0 published on Wednesday, Mar 27, 2024 by Pulumi