Class S3ApiDefinition

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

OpenAPI specification from an S3 archive.

public class S3ApiDefinition : ApiDefinition

Inheritance

object

ApiDefinition

S3ApiDefinition

Inherited Members

ApiDefinition.FromAsset(string, IAssetOptions)

ApiDefinition.FromBucket(IBucket, string, string)

ApiDefinition.FromInline(object)

ApiDefinition.BindAfterCreate(Construct, IRestApi)

Examples

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

            Bucket bucket;

            var s3ApiDefinition = new S3ApiDefinition(bucket, "key", "objectVersion");

Remarks

ExampleMetadata: fixture=_generated

Constructors

S3ApiDefinition(IBucket, string, string?)

public S3ApiDefinition(IBucket bucket, string key, string? objectVersion = null)

Parameters

bucket IBucket

key string

objectVersion string

Methods

Bind(Construct)

Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun.

public override IApiDefinitionConfig Bind(Construct scope)

Parameters

scope Construct

Returns

IApiDefinitionConfig