Class CfnRestApi.S3LocationProperty

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.

Inheritance

System.Object

CfnRestApi.S3LocationProperty

Implements

CfnRestApi.IS3LocationProperty

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class S3LocationProperty : Object, CfnRestApi.IS3LocationProperty

Syntax (vb)

Public Class S3LocationProperty
    Inherits Object
    Implements CfnRestApi.IS3LocationProperty

Remarks

On January 1, 2016, the Swagger Specification was donated to the OpenAPI initiative , 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

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

Constructors

S3LocationProperty()

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.

Constructors

S3LocationProperty()

public S3LocationProperty()

Properties

Bucket

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

public string Bucket { get; set; }

Property Value

System.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.

public string ETag { get; set; }

Property Value

System.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).

public string Key { get; set; }

Property Value

System.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.

public string Version { get; set; }

Property Value

System.String

Remarks

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

Implements

CfnRestApi.IS3LocationProperty