1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. opensearch
  6. DataSource

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
aws-native logo aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi

    Creates a data source for an Amazon OpenSearch Service domain.

    Create DataSource Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DataSource(name: string, args: DataSourceArgs, opts?: CustomResourceOptions);
    @overload
    def DataSource(resource_name: str,
                   args: DataSourceArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataSource(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   data_source_type: Optional[DataSourceTypeArgs] = None,
                   domain_name: Optional[str] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None)
    func NewDataSource(ctx *Context, name string, args DataSourceArgs, opts ...ResourceOption) (*DataSource, error)
    public DataSource(string name, DataSourceArgs args, CustomResourceOptions? opts = null)
    public DataSource(String name, DataSourceArgs args)
    public DataSource(String name, DataSourceArgs args, CustomResourceOptions options)
    
    type: aws-native:opensearch:DataSource
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_opensearch_data_source" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DataSourceArgs
    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 DataSourceArgs
    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 DataSourceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataSourceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DataSource Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DataSource resource accepts the following input properties:

    DataSourceType Pulumi.AwsNative.OpenSearch.Inputs.DataSourceType
    DomainName string
    The name of the OpenSearch Service domain.
    Description string
    A description of the data source.
    Name string
    The name of the data source.
    DataSourceType DataSourceTypeArgs
    DomainName string
    The name of the OpenSearch Service domain.
    Description string
    A description of the data source.
    Name string
    The name of the data source.
    data_source_type object
    domain_name string
    The name of the OpenSearch Service domain.
    description string
    A description of the data source.
    name string
    The name of the data source.
    dataSourceType DataSourceType
    domainName String
    The name of the OpenSearch Service domain.
    description String
    A description of the data source.
    name String
    The name of the data source.
    dataSourceType DataSourceType
    domainName string
    The name of the OpenSearch Service domain.
    description string
    A description of the data source.
    name string
    The name of the data source.
    data_source_type DataSourceTypeArgs
    domain_name str
    The name of the OpenSearch Service domain.
    description str
    A description of the data source.
    name str
    The name of the data source.
    dataSourceType Property Map
    domainName String
    The name of the OpenSearch Service domain.
    description String
    A description of the data source.
    name String
    The name of the data source.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) of the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.OpenSearch.DataSourceStatus
    The status of the data source.
    Arn string
    The Amazon Resource Name (ARN) of the data source.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status DataSourceStatus
    The status of the data source.
    arn string
    The Amazon Resource Name (ARN) of the data source.
    id string
    The provider-assigned unique ID for this managed resource.
    status "ACTIVE" | "DISABLED"
    The status of the data source.
    arn String
    The Amazon Resource Name (ARN) of the data source.
    id String
    The provider-assigned unique ID for this managed resource.
    status DataSourceStatus
    The status of the data source.
    arn string
    The Amazon Resource Name (ARN) of the data source.
    id string
    The provider-assigned unique ID for this managed resource.
    status DataSourceStatus
    The status of the data source.
    arn str
    The Amazon Resource Name (ARN) of the data source.
    id str
    The provider-assigned unique ID for this managed resource.
    status DataSourceStatus
    The status of the data source.
    arn String
    The Amazon Resource Name (ARN) of the data source.
    id String
    The provider-assigned unique ID for this managed resource.
    status "ACTIVE" | "DISABLED"
    The status of the data source.

    Supporting Types

    DataSourceS3GlueDataCatalog, DataSourceS3GlueDataCatalogArgs

    Configuration for an S3 Glue Data Catalog data source.
    RoleArn string
    The ARN of the IAM role that grants OpenSearch Service permission to access the Glue Data Catalog.
    RoleArn string
    The ARN of the IAM role that grants OpenSearch Service permission to access the Glue Data Catalog.
    role_arn string
    The ARN of the IAM role that grants OpenSearch Service permission to access the Glue Data Catalog.
    roleArn String
    The ARN of the IAM role that grants OpenSearch Service permission to access the Glue Data Catalog.
    roleArn string
    The ARN of the IAM role that grants OpenSearch Service permission to access the Glue Data Catalog.
    role_arn str
    The ARN of the IAM role that grants OpenSearch Service permission to access the Glue Data Catalog.
    roleArn String
    The ARN of the IAM role that grants OpenSearch Service permission to access the Glue Data Catalog.

    DataSourceStatus, DataSourceStatusArgs

    Active
    ACTIVE
    Disabled
    DISABLED
    DataSourceStatusActive
    ACTIVE
    DataSourceStatusDisabled
    DISABLED
    "ACTIVE"
    ACTIVE
    "DISABLED"
    DISABLED
    Active
    ACTIVE
    Disabled
    DISABLED
    Active
    ACTIVE
    Disabled
    DISABLED
    ACTIVE
    ACTIVE
    DISABLED
    DISABLED
    "ACTIVE"
    ACTIVE
    "DISABLED"
    DISABLED

    DataSourceType, DataSourceTypeArgs

    The type of data source.

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.79.0
    published on Monday, Sep 14, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial