Class CfnRestApiPropsMixin.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

object

CfnRestApiPropsMixin.S3LocationProperty

Implements

CfnRestApiPropsMixin.IS3LocationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnRestApiPropsMixin.S3LocationProperty : CfnRestApiPropsMixin.IS3LocationProperty

Syntax (vb)

Public Class CfnRestApiPropsMixin.S3LocationProperty Implements CfnRestApiPropsMixin.IS3LocationProperty

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.

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.Mixins.Preview.AWS.ApiGateway.Mixins;

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

Synopsis

Constructors

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.

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()

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 S3LocationProperty()

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.

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.Mixins.Preview.AWS.ApiGateway.Mixins;

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