Skip to content

Latest commit

 

History

History
685 lines (573 loc) · 35.9 KB

File metadata and controls

685 lines (573 loc) · 35.9 KB

AWS.S3 @ default

Resource AWS.S3/AccessGrant@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.S3/AccessGrantProperties (Required): properties of the resource

Resource AWS.S3/AccessGrantsInstance@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.S3/AccessGrantsLocation@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.S3/AccessPoint@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.S3/AccessPointProperties (Required): properties of the resource

Resource AWS.S3/Bucket@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.S3/BucketProperties: properties of the resource

Resource AWS.S3/BucketPolicy@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.S3/BucketPolicyProperties (Required): properties of the resource

Resource AWS.S3/MultiRegionAccessPointPolicy@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.S3/StorageLens@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.S3/StorageLensProperties (Required): properties of the resource

Resource AWS.S3/StorageLensGroup@default

  • Valid Scope(s): Unknown

Properties

AWS.S3/AccessGrantProperties

Properties

  • AccessGrantArn: string (ReadOnly): The Amazon Resource Name (ARN) of the specified access grant.
  • AccessGrantId: string (ReadOnly, Identifier): The ID assigned to this access grant.
  • AccessGrantsLocationConfiguration: AccessGrantsLocationConfiguration: The configuration options of the grant location, which is the S3 path to the data to which you are granting access.
  • AccessGrantsLocationId: string (Required): The custom S3 location to be accessed by the grantee
  • ApplicationArn: string: The ARN of the application grantees will use to access the location
  • Grantee: Grantee (Required): The principal who will be granted permission to access S3.
  • GrantScope: string (ReadOnly): The S3 path of the data to which you are granting access. It is a combination of the S3 path of the registered location and the subprefix.
  • Permission: string (Required): The level of access to be afforded to the grantee
  • S3PrefixType: string (WriteOnly): The type of S3SubPrefix.
  • Tags: Tag[] (WriteOnly)

AccessGrantsLocationConfiguration

Properties

  • S3SubPrefix: string (Required): The S3 sub prefix of a registered location in your S3 Access Grants instance

Grantee

Properties

  • GranteeIdentifier: string (Required): The unique identifier of the Grantee
  • GranteeType: string (Required): Configures the transfer acceleration state for an Amazon S3 bucket.

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

AWS.S3/AccessGrantsInstanceProperties

Properties

  • AccessGrantsInstanceArn: string (ReadOnly, Identifier): The Amazon Resource Name (ARN) of the specified Access Grants instance.
  • AccessGrantsInstanceId: string (ReadOnly): A unique identifier for the specified access grants instance.
  • IdentityCenterArn: string: The Amazon Resource Name (ARN) of the specified AWS Identity Center.
  • Tags: Tag[] (WriteOnly)

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

AWS.S3/AccessGrantsLocationProperties

Properties

  • AccessGrantsLocationArn: string (ReadOnly): The Amazon Resource Name (ARN) of the specified Access Grants location.
  • AccessGrantsLocationId: string (ReadOnly, Identifier): The unique identifier for the specified Access Grants location.
  • IamRoleArn: string: The Amazon Resource Name (ARN) of the access grant location's associated IAM role.
  • LocationScope: string: Descriptor for where the location actually points
  • Tags: Tag[] (WriteOnly)

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

AWS.S3/AccessPointProperties

Properties

  • Alias: string (ReadOnly): The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications.
  • Arn: string (ReadOnly): The Amazon Resource Name (ARN) of the specified accesspoint.
  • Bucket: string (Required): The name of the bucket that you want to associate this Access Point with.
  • BucketAccountId: string: The AWS account ID associated with the S3 bucket associated with this access point.
  • Name: string (Identifier): The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name.
  • NetworkOrigin: string (ReadOnly): Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies.
  • Policy: AccessPoint_Policy: The Access Point Policy you want to apply to this access point.
  • PublicAccessBlockConfiguration: PublicAccessBlockConfiguration: The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
  • VpcConfiguration: VpcConfiguration: If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC).

AccessPoint_Policy

Properties

PublicAccessBlockConfiguration

Properties

  • BlockPublicAcls: bool: Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE causes the following behavior:
  • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
  • PUT Object calls fail if the request includes a public ACL. . - PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.
  • BlockPublicPolicy: bool: Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.
  • IgnorePublicAcls: bool: Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
  • RestrictPublicBuckets: bool: Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

VpcConfiguration

Properties

  • VpcId: string: If this field is specified, this access point will only allow connections from the specified VPC ID.

AWS.S3/BucketProperties

Properties

  • AccelerateConfiguration: AccelerateConfiguration: Configuration for the transfer acceleration state.
  • AccessControl: string (WriteOnly): A canned access control list (ACL) that grants predefined permissions to the bucket.
  • AnalyticsConfigurations: AnalyticsConfiguration[]: The configuration and any analyses for the analytics filter of an Amazon S3 bucket.
  • Arn: string (ReadOnly): The Amazon Resource Name (ARN) of the specified bucket.
  • BucketEncryption: BucketEncryption
  • BucketName: string (Identifier): A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the bucket name.
  • CorsConfiguration: CorsConfiguration: Rules that define cross-origin resource sharing of objects in this bucket.
  • DomainName: string (ReadOnly): The IPv4 DNS name of the specified bucket.
  • DualStackDomainName: string (ReadOnly): The IPv6 DNS name of the specified bucket. For more information about dual-stack endpoints, see Using Amazon S3 Dual-Stack Endpoints.
  • IntelligentTieringConfigurations: IntelligentTieringConfiguration[]: Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
  • InventoryConfigurations: InventoryConfiguration[]: The inventory configuration for an Amazon S3 bucket.
  • LifecycleConfiguration: LifecycleConfiguration: Rules that define how Amazon S3 manages objects during their lifetime.
  • LoggingConfiguration: LoggingConfiguration: Settings that define where logs are stored.
  • MetricsConfigurations: MetricsConfiguration[]: Settings that define a metrics configuration for the CloudWatch request metrics from the bucket.
  • NotificationConfiguration: NotificationConfiguration: Configuration that defines how Amazon S3 handles bucket notifications.
  • ObjectLockConfiguration: ObjectLockConfiguration: Places an Object Lock configuration on the specified bucket.
  • ObjectLockEnabled: bool: Indicates whether this bucket has an Object Lock configuration enabled.
  • OwnershipControls: OwnershipControls: Specifies the container element for object ownership rules.
  • PublicAccessBlockConfiguration: PublicAccessBlockConfiguration
  • RegionalDomainName: string (ReadOnly): Returns the regional domain name of the specified bucket.
  • ReplicationConfiguration: ReplicationConfiguration: Configuration for replicating objects in an S3 bucket.
  • Tags: Tag[]: An arbitrary set of tags (key-value pairs) for this S3 bucket.
  • VersioningConfiguration: VersioningConfiguration
  • WebsiteConfiguration: WebsiteConfiguration
  • WebsiteURL: string (ReadOnly): The Amazon S3 website endpoint for the specified bucket.

AccelerateConfiguration

Properties

  • AccelerationStatus: string (Required): Configures the transfer acceleration state for an Amazon S3 bucket.

AnalyticsConfiguration

Properties

  • Id: string (Required): The ID that identifies the analytics configuration.
  • Prefix: string: The prefix that an object must have to be included in the analytics results.
  • StorageClassAnalysis: StorageClassAnalysis (Required)
  • TagFilters: TagFilter[]

StorageClassAnalysis

Properties

DataExport

Properties

  • Destination: Destination (Required)
  • OutputSchemaVersion: string (Required): The version of the output schema to use when exporting data.

Destination

Properties

  • BucketAccountId: string: The account ID that owns the destination S3 bucket.
  • BucketArn: string (Required): The Amazon Resource Name (ARN) of the bucket to which data is exported.
  • Format: string (Required): Specifies the file format used when exporting data to Amazon S3.
  • Prefix: string: The prefix to use when exporting data. The prefix is prepended to all results.

TagFilter

Properties

  • Key: string (Required)
  • Value: string (Required)

BucketEncryption

Properties

  • ServerSideEncryptionConfiguration: ServerSideEncryptionRule[] (Required): Specifies the default server-side-encryption configuration.

ServerSideEncryptionRule

Properties

  • BucketKeyEnabled: bool: Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.
  • ServerSideEncryptionByDefault: ServerSideEncryptionByDefault

ServerSideEncryptionByDefault

Properties

  • KMSMasterKeyID: string: "KMSMasterKeyID" can only be used when you set the value of SSEAlgorithm as aws:kms or aws:kms:dsse.
  • SSEAlgorithm: string (Required)

CorsConfiguration

Properties

CorsRule

Properties

  • AllowedHeaders: string[]: Headers that are specified in the Access-Control-Request-Headers header.
  • AllowedMethods: string[] (Required): An HTTP method that you allow the origin to execute.
  • AllowedOrigins: string[] (Required): One or more origins you want customers to be able to access the bucket from.
  • ExposedHeaders: string[]: One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).
  • Id: string: A unique identifier for this rule.
  • MaxAge: int: The time in seconds that your browser is to cache the preflight response for the specified resource.

IntelligentTieringConfiguration

Properties

  • Id: string (Required): The ID used to identify the S3 Intelligent-Tiering configuration.
  • Prefix: string: An object key name prefix that identifies the subset of objects to which the rule applies.
  • Status: string (Required): Specifies the status of the configuration.
  • TagFilters: TagFilter[]: A container for a key-value pair.
  • Tierings: Tiering[] (Required): Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS.

Tiering

Properties

  • AccessTier: string (Required): S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.
  • Days: int (Required): The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).

InventoryConfiguration

Properties

  • Destination: Destination (Required)
  • Enabled: bool (Required): Specifies whether the inventory is enabled or disabled.
  • Id: string (Required): The ID used to identify the inventory configuration.
  • IncludedObjectVersions: string (Required): Object versions to include in the inventory list.
  • OptionalFields: string[]: Contains the optional fields that are included in the inventory results.
  • Prefix: string: The prefix that is prepended to all inventory results.
  • ScheduleFrequency: string (Required): Specifies the schedule for generating inventory results.

LifecycleConfiguration

Properties

  • Rules: Rule[] (Required, WriteOnly): A lifecycle rule for individual objects in an Amazon S3 bucket.

Rule

Properties

AbortIncompleteMultipartUpload

Properties

  • DaysAfterInitiation: int (Required): Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

NoncurrentVersionExpiration

Properties

  • NewerNoncurrentVersions: int: Specified the number of newer noncurrent and current versions that must exists before performing the associated action
  • NoncurrentDays: int (Required): Specified the number of days an object is noncurrent before Amazon S3 can perform the associated action

NoncurrentVersionTransition

Properties

  • NewerNoncurrentVersions: int: Specified the number of newer noncurrent and current versions that must exists before performing the associated action
  • StorageClass: string (Required): The class of storage used to store the object.
  • TransitionInDays: int (Required): Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action.

Transition

Properties

  • StorageClass: string (Required)
  • TransitionDate: string
  • TransitionInDays: int

LoggingConfiguration

Properties

  • DestinationBucketName: string: The name of an Amazon S3 bucket where Amazon S3 store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the LoggingConfiguration property is defined.
  • LogFilePrefix: string
  • TargetObjectKeyFormat: TargetObjectKeyFormat

TargetObjectKeyFormat

Properties

MetricsConfiguration

Properties

  • AccessPointArn: string
  • Id: string (Required)
  • Prefix: string
  • TagFilters: TagFilter[]

NotificationConfiguration

Properties

EventBridgeConfiguration

Properties

  • EventBridgeEnabled: bool (Required): Specifies whether to send notifications to Amazon EventBridge when events occur in an Amazon S3 bucket.

LambdaConfiguration

Properties

  • Event: string (Required): The Amazon S3 bucket event for which to invoke the AWS Lambda function.
  • Filter: NotificationFilter: The filtering rules that determine which objects invoke the AWS Lambda function.
  • Function: string (Required): The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.

NotificationFilter

Properties

S3KeyFilter

Properties

FilterRule

Properties

  • Name: string (Required)
  • Value: string (Required)

QueueConfiguration

Properties

  • Event: string (Required): The Amazon S3 bucket event about which you want to publish messages to Amazon SQS.
  • Filter: NotificationFilter: The filtering rules that determine which objects trigger notifications.
  • Queue: string (Required): The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.

TopicConfiguration

Properties

  • Event: string (Required): The Amazon S3 bucket event about which to send notifications.
  • Filter: NotificationFilter: The filtering rules that determine for which objects to send notifications.
  • Topic: string (Required): The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

ObjectLockConfiguration

Properties

ObjectLockRule

Properties

DefaultRetention

Properties

  • Days: int
  • Mode: string
  • Years: int

OwnershipControls

Properties

OwnershipControlsRule

Properties

  • ObjectOwnership: string: Specifies an object ownership rule.

PublicAccessBlockConfiguration

Properties

  • BlockPublicAcls: bool: Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:
  • PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
  • PUT Object calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs.
  • BlockPublicPolicy: bool: Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies.
  • IgnorePublicAcls: bool: Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
  • RestrictPublicBuckets: bool: Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only AWS services and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

ReplicationConfiguration

Properties

  • Role: string (Required): The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects.
  • Rules: ReplicationRule[] (Required, WriteOnly): A container for one or more replication rules.

ReplicationRule

Properties

DeleteMarkerReplication

Properties

  • Status: string

ReplicationDestination

Properties

AccessControlTranslation

Properties

  • Owner: string (Required)

EncryptionConfiguration

Properties

  • ReplicaKmsKeyID: string (Required): Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket.

Metrics

Properties

ReplicationTimeValue

Properties

  • Minutes: int (Required)

ReplicationTime

Properties

ReplicationRuleFilter

Properties

ReplicationRuleAndOperator

Properties

SourceSelectionCriteria

Properties

  • ReplicaModifications: ReplicaModifications: A filter that you can specify for selection for modifications on replicas.
  • SseKmsEncryptedObjects: SseKmsEncryptedObjects: A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS.

ReplicaModifications

Properties

  • Status: string (Required): Specifies whether Amazon S3 replicates modifications on replicas.

SseKmsEncryptedObjects

Properties

  • Status: string (Required): Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service.

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

VersioningConfiguration

Properties

  • Status: string (Required): The versioning state of the bucket.

WebsiteConfiguration

Properties

  • ErrorDocument: string: The name of the error document for the website.
  • IndexDocument: string: The name of the index document for the website.
  • RedirectAllRequestsTo: RedirectAllRequestsTo
  • RoutingRules: RoutingRule[]

RedirectAllRequestsTo

Properties

  • HostName: string (Required): Name of the host where requests are redirected.
  • Protocol: string: Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

RoutingRule

Properties

  • RedirectRule: RedirectRule (Required): Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.
  • RoutingRuleCondition: RoutingRuleCondition

RedirectRule

Properties

  • HostName: string: The host name to use in the redirect request.
  • HttpRedirectCode: string: The HTTP redirect code to use on the response. Not required if one of the siblings is present.
  • Protocol: string: Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
  • ReplaceKeyPrefixWith: string: The object key prefix to use in the redirect request.
  • ReplaceKeyWith: string: The specific object key to use in the redirect request.d

RoutingRuleCondition

Properties

  • HttpErrorCodeReturnedEquals: string: The HTTP error code when the redirect is applied.
  • KeyPrefixEquals: string: The object key name prefix when the redirect is applied.

AWS.S3/BucketPolicyProperties

Properties

  • Bucket: string (Required, Identifier): The name of the Amazon S3 bucket to which the policy applies.
  • PolicyDocument: BucketPolicy_PolicyDocument | string (Required): A policy document containing permissions to add to the specified bucket. In IAM, you must provide policy documents in JSON format. However, in CloudFormation you can provide the policy in JSON or YAML format because CloudFormation converts YAML to JSON before submitting it to IAM.

AWS.S3/MultiRegionAccessPointPolicyProperties

Properties

MultiRegionAccessPointPolicy_Policy

Properties

MultiRegionAccessPointPolicy_PolicyStatus

Properties

  • IsPublic: string (Required, ReadOnly): Specifies whether the policy is public or not.

AWS.S3/StorageLensProperties

Properties

  • StorageLensConfiguration: StorageLensConfiguration (Required)
  • Tags: Tag[]: A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.

StorageLensConfiguration

Properties

  • AccountLevel: AccountLevel (Required)
  • AwsOrg: AwsOrg
  • DataExport: DataExport
  • Exclude: BucketsAndRegions
  • Id: string (Required)
  • Include: BucketsAndRegions
  • IsEnabled: bool (Required): Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.
  • StorageLensArn: string (ReadOnly): The ARN for the Amazon S3 Storage Lens configuration.

AccountLevel

Properties

ActivityMetrics

Properties

  • IsEnabled: bool: Specifies whether activity metrics are enabled or disabled.

AdvancedCostOptimizationMetrics

Properties

  • IsEnabled: bool: Specifies whether advanced cost optimization metrics are enabled or disabled.

AdvancedDataProtectionMetrics

Properties

  • IsEnabled: bool: Specifies whether advanced data protection metrics are enabled or disabled.

BucketLevel

Properties

DetailedStatusCodesMetrics

Properties

  • IsEnabled: bool: Specifies whether detailed status codes metrics are enabled or disabled.

PrefixLevel

Properties

PrefixLevelStorageMetrics

Properties

  • IsEnabled: bool: Specifies whether prefix-level storage metrics are enabled or disabled.
  • SelectionCriteria: SelectionCriteria

SelectionCriteria

Properties

  • Delimiter: string: Delimiter to divide S3 key into hierarchy of prefixes.
  • MaxDepth: int: Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.
  • MinStorageBytesPercentage: int: The minimum storage bytes threshold for the prefixes to be included in the analysis.

StorageLensGroupLevel

Properties

StorageLensGroupSelectionCriteria

Properties

  • Exclude: string[]
  • Include: string[]

AwsOrg

Properties

  • Arn: string (Required)

DataExport

Properties

CloudWatchMetrics

Properties

  • IsEnabled: bool (Required): Specifies whether CloudWatch metrics are enabled or disabled.

S3BucketDestination

Properties

  • AccountId: string (Required): The AWS account ID that owns the destination S3 bucket.
  • Arn: string (Required): The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.
  • Encryption: Encryption
  • Format: string (Required): Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.
  • OutputSchemaVersion: string (Required): The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.
  • Prefix: string: The prefix to use for Amazon S3 Storage Lens export.

Encryption

Properties

BucketsAndRegions

Properties

  • Buckets: string[]
  • Regions: string[]

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

AWS.S3/StorageLensGroupProperties

Properties

  • Filter: Filter (Required)
  • Name: string (Required, Identifier)
  • StorageLensGroupArn: string (ReadOnly): The ARN for the Amazon S3 Storage Lens Group.
  • Tags: Tag[]: A set of tags (key-value pairs) for this Amazon S3 Storage Lens Group.

Filter

Properties

And

Properties

Tag

Properties

  • Key: string (Required)
  • Value: string (Required)

MatchObjectAge

Properties

  • DaysGreaterThan: int: Minimum object age to which the rule applies.
  • DaysLessThan: int: Maximum object age to which the rule applies.

MatchObjectSize

Properties

  • BytesGreaterThan: int: Minimum object size to which the rule applies.
  • BytesLessThan: int: Maximum object size to which the rule applies.

Or

Properties