Interface CfnRestApi.IS3LocationProperty

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.

Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IS3LocationProperty
Syntax (vb)
Public Interface IS3LocationProperty
Remarks

On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative , becoming the foundation of the OpenAPI Specification.

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

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;

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

Synopsis

Properties

Bucket

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

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

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

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

Properties

Bucket

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

virtual string Bucket { get; }
Property Value

System.String

Remarks

See: 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.

virtual string ETag { get; }
Property Value

System.String

Remarks

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

See: 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).

virtual string Key { get; }
Property Value

System.String

Remarks

See: 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.

virtual string Version { get; }
Property Value

System.String

Remarks

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