Source: resources/s3.js

  1. 'use strict'
  3. const WKResource = require('./../resource').WKResource
  4. const ResourceAttribute = require('./../resourceattribute').ResourceAttribute
  5. const ResourceAttributeArray = require('./../resourceattribute').ResourceAttributeArray
  6. const tag = require('./../tag')
  7. const types = require('./../types')
  9. /** @module S3 */
  11. /** @memberof module:S3
  12. *   @extends WKResource
  13. * @property {String} AccessControl Required: No. A canned access control list (ACL) that grants predefined permissions to the
  14.                   bucket. For more information about canned ACLs, see Canned ACLs in the
  15.                      Amazon S3 documentation.Valid values: AuthenticatedRead |
  16.                             AwsExecRead | BucketOwnerRead |
  17.                             BucketOwnerFullControl |
  18.                             LogDeliveryWrite | Private |
  19.                             PublicRead |
  20.                         PublicReadWriteUpdate requires: No interruption
  21. * @property {String} BucketName Required: No. A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique
  22.                   physical ID and uses that ID for the bucket name. For more information, see Name Type. The bucket
  23.                   name must contain only lowercase letters, numbers, periods (.), and dashes
  24.                   (-).ImportantIf you specify a name, you cannot do updates that require this resource to be replaced.
  25. You can still do updates that require no or some interruption. If you must replace the resource, specify a new name.Update requires: Replacement
  26. * @property {AmazonS3CorsConfiguration} CorsConfiguration Required: No. Rules that define cross-origin resource sharing of objects in this bucket.
  27.                         For more information, see Enabling
  28.                             Cross-Origin Resource Sharing in the
  29.                             Amazon Simple Storage Service Developer Guide.Update requires: No interruption
  30. * @property {AmazonS3LifecycleConfiguration} LifecycleConfiguration Required: No. Rules that define how Amazon S3 manages objects during their lifetime. For more
  31.                         information, see Object
  32.                             Lifecycle Management in the
  33.                             Amazon Simple Storage Service Developer Guide.Update requires: No interruption
  34. * @property {AmazonS3LoggingConfiguration} LoggingConfiguration Required: No. Settings that defines where logs are stored.Update requires: No interruption
  35. * @property {AmazonS3NotificationConfiguration} NotificationConfiguration Required: No. Configuration that defines how Amazon S3 handles bucket notifications.Update requires: No interruption
  36. * @property {AmazonS3ReplicationConfiguration} ReplicationConfiguration Required: No. Configuration for replicating objects in an S3 bucket. To enable replication, you
  37.             must also enable versioning by using the VersioningConfiguration
  38.             property.Amazon S3 can store replicated objects in only one destination (S3 bucket). You cannot
  39.             send replicated objects to multiple S3 buckets.Update requires: No interruption
  40. * @property {AWSCloudFormationResourceTags} Tags Required: No. An arbitrary set of tags (key-value pairs) for this Amazon S3 bucket.Update requires: No interruption
  41. * @property {AmazonS3VersioningConfiguration} VersioningConfiguration Required: No. Enables multiple variants of all objects in this bucket. You might enable
  42.                         versioning to prevent objects from being deleted or overwritten by mistake
  43.                         or to archive objects so that you can retrieve previous versions of
  44.                         them.Update requires: No interruption
  45. * @property {AmazonS3WebsiteConfigurationProperty} WebsiteConfiguration Required: No. Information used to configure the bucket as a static website. For more information, see Hosting Websites on Amazon
  46.                   S3.Update requires: No interruption
  47. */
  48. class Bucket extends WKResource {
  49.   constructor (name, propertiesObject) {
  50.     let resourceType = 'AWS::S3::Bucket'
  51.     let properties = {
  52.       AccessControl: new ResourceAttribute('AccessControl', String, 'No', null),
  53.       BucketName: new ResourceAttribute('BucketName', String, 'No', null),
  54.       CorsConfiguration: new ResourceAttribute('CorsConfiguration', types.AmazonS3CorsConfiguration, 'No', null),
  55.       LifecycleConfiguration: new ResourceAttribute('LifecycleConfiguration', types.AmazonS3LifecycleConfiguration, 'No', null),
  56.       LoggingConfiguration: new ResourceAttribute('LoggingConfiguration', types.AmazonS3LoggingConfiguration, 'No', null),
  57.       NotificationConfiguration: new ResourceAttribute('NotificationConfiguration', types.AmazonS3NotificationConfiguration, 'No', null),
  58.       ReplicationConfiguration: new ResourceAttribute('ReplicationConfiguration', types.AmazonS3ReplicationConfiguration, 'No', null),
  59.       Tags: new tag.TagSet(),
  60.       VersioningConfiguration: new ResourceAttribute('VersioningConfiguration', types.AmazonS3VersioningConfiguration, 'No', null),
  61.       WebsiteConfiguration: new ResourceAttribute('WebsiteConfiguration', types.AmazonS3WebsiteConfigurationProperty, 'No', null)
  62.     }
  63.     super(name, resourceType, properties, propertiesObject)
  64.   }
  65. }
  67. /** @memberof module:S3
  68. *   @extends WKResource
  69. * @property {String} Bucket Required: Yes. The Amazon S3 bucket that the policy applies to.You cannot update this property. If you want to add or remove a bucket from a
  70.             bucket policy, you must modify your AWS CloudFormation template by creating a new bucket policy
  71.             resource and removing the old one. Then use the modified template to update your AWS CloudFormation
  72.             stack.
  73. * @property {Object} PolicyDocument Required: Yes. A policy document containing permissions to add to the specified bucket. For
  74.             more information, see Access Policy Language Overview in the
  75.             Amazon Simple Storage Service Developer Guide.Update requires: No interruption
  76. */
  77. class BucketPolicy extends WKResource {
  78.   constructor (name, propertiesObject) {
  79.     let resourceType = 'AWS::S3::BucketPolicy'
  80.     let properties = {
  81.       Bucket: new ResourceAttribute('Bucket', String, 'Yes', null),
  82.       PolicyDocument: new ResourceAttribute('PolicyDocument', Object, 'Yes', null)
  83.     }
  84.     super(name, resourceType, properties, propertiesObject)
  85.   }
  86. }
  88. module.exports = {  Bucket: Bucket,
  89.   BucketPolicy: BucketPolicy
  90. }