Interface CfnRestApi.IS3LocationProperty

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

S3Location is a property of the AWS::ApiGateway::RestApi resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.

public interface CfnRestApi.IS3LocationProperty

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;

             var s3LocationProperty = new S3LocationProperty {
                 Bucket = "bucket",
                 ETag = "eTag",
                 Key = "key",
                 Version = "version"
             };

Remarks

On January 1, 2016, the Swagger Specification was donated to the <a href="https://docs.aws.amazon.com/https://www.openapis.org/">OpenAPI initiative</a> , becoming the foundation of the OpenAPI Specification.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html

ExampleMetadata: fixture=_generated

Properties

Bucket

The name of the S3 bucket where the OpenAPI file is stored.

string? Bucket { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket

ETag

The Amazon S3 ETag (a file checksum) of the OpenAPI file.

string? ETag { get; }

Property Value

string

Remarks

If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-etag

Key

The file name of the OpenAPI file (Amazon S3 object name).

string? Key { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key

Version

For versioning-enabled buckets, a specific version of the OpenAPI file.

string? Version { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version