Class S3ApiDefinition
OpenAPI specification from an S3 archive.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3ApiDefinition : ApiDefinition
Syntax (vb)
Public Class S3ApiDefinition
Inherits ApiDefinition
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.APIGateway;
using Amazon.CDK.AWS.S3;
Bucket bucket;
var s3ApiDefinition = new S3ApiDefinition(bucket, "key", "objectVersion");
Synopsis
Constructors
S3ApiDefinition(IBucket, String, String) | |
S3ApiDefinition(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
S3ApiDefinition(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
Bind(Construct) | Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun. |
Constructors
S3ApiDefinition(IBucket, String, String)
public S3ApiDefinition(IBucket bucket, string key, string objectVersion = null)
Parameters
- bucket IBucket
- key System.String
- objectVersion System.String
S3ApiDefinition(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected S3ApiDefinition(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
S3ApiDefinition(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected S3ApiDefinition(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
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 Constructs.Construct
Returns