Class HttpDataSourceProps

Properties for an AppSync http datasource.

Inheritance

object

HttpDataSourceProps

Implements

IHttpDataSourceProps

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 HttpDataSourceProps : IHttpDataSourceProps, IBackedDataSourceProps, IBaseDataSourceProps

Syntax (vb)

Public Class HttpDataSourceProps Implements IHttpDataSourceProps, 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.Interfaces.AppSync;

            IGraphQLApiRef graphQLApiRef;
            Role role;

            var httpDataSourceProps = new HttpDataSourceProps {
                Api = graphQLApiRef,
                Endpoint = "endpoint",

                // the properties below are optional
                AuthorizationConfig = new AwsIamConfig {
                    SigningRegion = "signingRegion",
                    SigningServiceName = "signingServiceName"
                },
                Description = "description",
                Name = "name",
                ServiceRole = role
            };

Synopsis

Constructors

HttpDataSourceProps()

Properties for an AppSync http datasource.

Properties

Api	The API to attach this data source to.
AuthorizationConfig	The authorization config in case the HTTP endpoint requires authorization.
Description	the description of the data source.
Endpoint	The http endpoint.
Name	The name of the data source.
ServiceRole	The IAM service role to be assumed by AppSync to interact with the data source.

Constructors

HttpDataSourceProps()

Properties for an AppSync http datasource.

public HttpDataSourceProps()

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.Interfaces.AppSync;

            IGraphQLApiRef graphQLApiRef;
            Role role;

            var httpDataSourceProps = new HttpDataSourceProps {
                Api = graphQLApiRef,
                Endpoint = "endpoint",

                // the properties below are optional
                AuthorizationConfig = new AwsIamConfig {
                    SigningRegion = "signingRegion",
                    SigningServiceName = "signingServiceName"
                },
                Description = "description",
                Name = "name",
                ServiceRole = role
            };

Properties

Api

The API to attach this data source to.

public IGraphQLApiRef Api { get; set; }

Property Value

IGraphQLApiRef

Remarks

ExampleMetadata: fixture=_generated

AuthorizationConfig

The authorization config in case the HTTP endpoint requires authorization.

public IAwsIamConfig? AuthorizationConfig { get; set; }

Property Value

IAwsIamConfig

Remarks

Default: - none

Description

the description of the data source.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - None

Endpoint

The http endpoint.

public string Endpoint { get; set; }

Property Value

string

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

IHttpDataSourceProps

IBackedDataSourceProps

IBaseDataSourceProps