Class OpenSearchDataSourceProps

Properties for the OpenSearch Data Source.

Inheritance

object

OpenSearchDataSourceProps

Implements

IOpenSearchDataSourceProps

IBackedDataSourceProps

IBaseDataSourceProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppSync

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class OpenSearchDataSourceProps : IOpenSearchDataSourceProps, IBackedDataSourceProps, IBaseDataSourceProps

Syntax (vb)

Public Class OpenSearchDataSourceProps Implements IOpenSearchDataSourceProps, IBackedDataSourceProps, IBaseDataSourceProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.AppSync;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.AWS.OpenSearchService;

            Domain domain;
            GraphqlApi graphqlApi;
            Role role;

            var openSearchDataSourceProps = new OpenSearchDataSourceProps {
                Api = graphqlApi,
                Domain = domain,

                // the properties below are optional
                Description = "description",
                Name = "name",
                ServiceRole = role
            };

Synopsis

Constructors

OpenSearchDataSourceProps()

Properties for the OpenSearch Data Source.

Properties

Api	The API to attach this data source to.
Description	the description of the data source.
Domain	The OpenSearch domain containing the endpoint for the data source.
Name	The name of the data source.
ServiceRole	The IAM service role to be assumed by AppSync to interact with the data source.

Constructors

OpenSearchDataSourceProps()

Properties for the OpenSearch Data Source.

public OpenSearchDataSourceProps()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.AppSync;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.AWS.OpenSearchService;

            Domain domain;
            GraphqlApi graphqlApi;
            Role role;

            var openSearchDataSourceProps = new OpenSearchDataSourceProps {
                Api = graphqlApi,
                Domain = domain,

                // the properties below are optional
                Description = "description",
                Name = "name",
                ServiceRole = role
            };

Properties

Api

The API to attach this data source to.

public IGraphqlApi Api { get; set; }

Property Value

IGraphqlApi

Remarks

ExampleMetadata: fixture=_generated

Description

the description of the data source.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - None

Domain

The OpenSearch domain containing the endpoint for the data source.

public IDomain Domain { get; set; }

Property Value

IDomain

Remarks

ExampleMetadata: fixture=_generated

Name

The name of the data source.

public string? Name { get; set; }

Property Value

string

Remarks

Default: - id of data source

ServiceRole

The IAM service role to be assumed by AppSync to interact with the data source.

public IRole? ServiceRole { get; set; }

Property Value

IRole

Remarks

Default: - Create a new role

Implements

IOpenSearchDataSourceProps

IBackedDataSourceProps

IBaseDataSourceProps