Interface IHttpApiAttributes

Attributes for importing an HttpApi into the CDK.

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IHttpApiAttributes

Syntax (vb)

Public Interface IHttpApiAttributes

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.Apigatewayv2;

            var httpApiAttributes = new HttpApiAttributes {
                HttpApiId = "httpApiId",

                // the properties below are optional
                ApiEndpoint = "apiEndpoint"
            };

Synopsis

Properties

ApiEndpoint	The endpoint URL of the HttpApi.
HttpApiId	The identifier of the HttpApi.

Properties

ApiEndpoint

The endpoint URL of the HttpApi.

string? ApiEndpoint { get; }

Property Value

string

Remarks

Default: - throws an error if apiEndpoint is accessed.

HttpApiId

The identifier of the HttpApi.

string HttpApiId { get; }

Property Value

string

Remarks

See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#aws-resource-apigatewayv2-api-return-values