1. Packages
  2. AWS Native
  3. API Docs
  4. s3
  5. StorageLens

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

aws-native.s3.StorageLens

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

    The AWS::S3::StorageLens resource is an Amazon S3 resource type that you can use to create Storage Lens configurations.

    Create StorageLens Resource

    new StorageLens(name: string, args: StorageLensArgs, opts?: CustomResourceOptions);
    @overload
    def StorageLens(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    storage_lens_configuration: Optional[StorageLensConfigurationArgs] = None,
                    tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    @overload
    def StorageLens(resource_name: str,
                    args: StorageLensArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewStorageLens(ctx *Context, name string, args StorageLensArgs, opts ...ResourceOption) (*StorageLens, error)
    public StorageLens(string name, StorageLensArgs args, CustomResourceOptions? opts = null)
    public StorageLens(String name, StorageLensArgs args)
    public StorageLens(String name, StorageLensArgs args, CustomResourceOptions options)
    
    type: aws-native:s3:StorageLens
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args StorageLensArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StorageLensArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StorageLensArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StorageLensArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StorageLensArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    StorageLens Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The StorageLens resource accepts the following input properties:

    StorageLensConfiguration Pulumi.AwsNative.S3.Inputs.StorageLensConfiguration
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
    StorageLensConfiguration StorageLensConfigurationArgs
    Tags TagArgs
    A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
    storageLensConfiguration StorageLensConfiguration
    tags List<Tag>
    A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
    storageLensConfiguration StorageLensConfiguration
    tags Tag[]
    A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
    storage_lens_configuration StorageLensConfigurationArgs
    tags TagArgs]
    A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.
    storageLensConfiguration Property Map
    tags List<Property Map>
    A set of tags (key-value pairs) for this Amazon S3 Storage Lens configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the StorageLens resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    StorageLensAccountLevel, StorageLensAccountLevelArgs

    StorageLensActivityMetrics, StorageLensActivityMetricsArgs

    IsEnabled bool
    Specifies whether activity metrics are enabled or disabled.
    IsEnabled bool
    Specifies whether activity metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether activity metrics are enabled or disabled.
    isEnabled boolean
    Specifies whether activity metrics are enabled or disabled.
    is_enabled bool
    Specifies whether activity metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether activity metrics are enabled or disabled.

    StorageLensAdvancedCostOptimizationMetrics, StorageLensAdvancedCostOptimizationMetricsArgs

    IsEnabled bool
    Specifies whether advanced cost optimization metrics are enabled or disabled.
    IsEnabled bool
    Specifies whether advanced cost optimization metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether advanced cost optimization metrics are enabled or disabled.
    isEnabled boolean
    Specifies whether advanced cost optimization metrics are enabled or disabled.
    is_enabled bool
    Specifies whether advanced cost optimization metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether advanced cost optimization metrics are enabled or disabled.

    StorageLensAdvancedDataProtectionMetrics, StorageLensAdvancedDataProtectionMetricsArgs

    IsEnabled bool
    Specifies whether advanced data protection metrics are enabled or disabled.
    IsEnabled bool
    Specifies whether advanced data protection metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether advanced data protection metrics are enabled or disabled.
    isEnabled boolean
    Specifies whether advanced data protection metrics are enabled or disabled.
    is_enabled bool
    Specifies whether advanced data protection metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether advanced data protection metrics are enabled or disabled.

    StorageLensAwsOrg, StorageLensAwsOrgArgs

    Arn string
    Arn string
    arn String
    arn string
    arn str
    arn String

    StorageLensBucketLevel, StorageLensBucketLevelArgs

    StorageLensBucketsAndRegions, StorageLensBucketsAndRegionsArgs

    Buckets List<string>
    Regions List<string>
    Buckets []string
    Regions []string
    buckets List<String>
    regions List<String>
    buckets string[]
    regions string[]
    buckets Sequence[str]
    regions Sequence[str]
    buckets List<String>
    regions List<String>

    StorageLensCloudWatchMetrics, StorageLensCloudWatchMetricsArgs

    IsEnabled bool
    Specifies whether CloudWatch metrics are enabled or disabled.
    IsEnabled bool
    Specifies whether CloudWatch metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether CloudWatch metrics are enabled or disabled.
    isEnabled boolean
    Specifies whether CloudWatch metrics are enabled or disabled.
    is_enabled bool
    Specifies whether CloudWatch metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether CloudWatch metrics are enabled or disabled.

    StorageLensConfiguration, StorageLensConfigurationArgs

    AccountLevel StorageLensAccountLevel
    Id string
    IsEnabled bool
    Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.
    AwsOrg StorageLensAwsOrg
    DataExport StorageLensDataExport
    Exclude StorageLensBucketsAndRegions
    Include StorageLensBucketsAndRegions
    StorageLensArn string
    The ARN for the Amazon S3 Storage Lens configuration.
    accountLevel StorageLensAccountLevel
    id String
    isEnabled Boolean
    Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.
    awsOrg StorageLensAwsOrg
    dataExport StorageLensDataExport
    exclude StorageLensBucketsAndRegions
    include StorageLensBucketsAndRegions
    storageLensArn String
    The ARN for the Amazon S3 Storage Lens configuration.
    accountLevel StorageLensAccountLevel
    id string
    isEnabled boolean
    Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.
    awsOrg StorageLensAwsOrg
    dataExport StorageLensDataExport
    exclude StorageLensBucketsAndRegions
    include StorageLensBucketsAndRegions
    storageLensArn string
    The ARN for the Amazon S3 Storage Lens configuration.
    account_level StorageLensAccountLevel
    id str
    is_enabled bool
    Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.
    aws_org StorageLensAwsOrg
    data_export StorageLensDataExport
    exclude StorageLensBucketsAndRegions
    include StorageLensBucketsAndRegions
    storage_lens_arn str
    The ARN for the Amazon S3 Storage Lens configuration.
    accountLevel Property Map
    id String
    isEnabled Boolean
    Specifies whether the Amazon S3 Storage Lens configuration is enabled or disabled.
    awsOrg Property Map
    dataExport Property Map
    exclude Property Map
    include Property Map
    storageLensArn String
    The ARN for the Amazon S3 Storage Lens configuration.

    StorageLensDataExport, StorageLensDataExportArgs

    StorageLensDetailedStatusCodesMetrics, StorageLensDetailedStatusCodesMetricsArgs

    IsEnabled bool
    Specifies whether detailed status codes metrics are enabled or disabled.
    IsEnabled bool
    Specifies whether detailed status codes metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether detailed status codes metrics are enabled or disabled.
    isEnabled boolean
    Specifies whether detailed status codes metrics are enabled or disabled.
    is_enabled bool
    Specifies whether detailed status codes metrics are enabled or disabled.
    isEnabled Boolean
    Specifies whether detailed status codes metrics are enabled or disabled.

    StorageLensGroupLevel, StorageLensGroupLevelArgs

    StorageLensGroupSelectionCriteria, StorageLensGroupSelectionCriteriaArgs

    Exclude List<string>
    Include List<string>
    Exclude []string
    Include []string
    exclude List<String>
    include List<String>
    exclude string[]
    include string[]
    exclude Sequence[str]
    include Sequence[str]
    exclude List<String>
    include List<String>

    StorageLensPrefixLevel, StorageLensPrefixLevelArgs

    StorageLensPrefixLevelStorageMetrics, StorageLensPrefixLevelStorageMetricsArgs

    IsEnabled bool
    Specifies whether prefix-level storage metrics are enabled or disabled.
    SelectionCriteria Pulumi.AwsNative.S3.Inputs.StorageLensSelectionCriteria
    IsEnabled bool
    Specifies whether prefix-level storage metrics are enabled or disabled.
    SelectionCriteria StorageLensSelectionCriteria
    isEnabled Boolean
    Specifies whether prefix-level storage metrics are enabled or disabled.
    selectionCriteria StorageLensSelectionCriteria
    isEnabled boolean
    Specifies whether prefix-level storage metrics are enabled or disabled.
    selectionCriteria StorageLensSelectionCriteria
    is_enabled bool
    Specifies whether prefix-level storage metrics are enabled or disabled.
    selection_criteria StorageLensSelectionCriteria
    isEnabled Boolean
    Specifies whether prefix-level storage metrics are enabled or disabled.
    selectionCriteria Property Map

    StorageLensS3BucketDestination, StorageLensS3BucketDestinationArgs

    AccountId string
    The AWS account ID that owns the destination S3 bucket.
    Arn string
    The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.
    Format Pulumi.AwsNative.S3.StorageLensS3BucketDestinationFormat
    Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.
    OutputSchemaVersion Pulumi.AwsNative.S3.StorageLensS3BucketDestinationOutputSchemaVersion
    The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.
    Encryption Pulumi.AwsNative.S3.Inputs.StorageLensEncryption
    Prefix string
    The prefix to use for Amazon S3 Storage Lens export.
    AccountId string
    The AWS account ID that owns the destination S3 bucket.
    Arn string
    The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.
    Format StorageLensS3BucketDestinationFormat
    Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.
    OutputSchemaVersion StorageLensS3BucketDestinationOutputSchemaVersion
    The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.
    Encryption StorageLensEncryption
    Prefix string
    The prefix to use for Amazon S3 Storage Lens export.
    accountId String
    The AWS account ID that owns the destination S3 bucket.
    arn String
    The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.
    format StorageLensS3BucketDestinationFormat
    Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.
    outputSchemaVersion StorageLensS3BucketDestinationOutputSchemaVersion
    The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.
    encryption StorageLensEncryption
    prefix String
    The prefix to use for Amazon S3 Storage Lens export.
    accountId string
    The AWS account ID that owns the destination S3 bucket.
    arn string
    The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.
    format StorageLensS3BucketDestinationFormat
    Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.
    outputSchemaVersion StorageLensS3BucketDestinationOutputSchemaVersion
    The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.
    encryption StorageLensEncryption
    prefix string
    The prefix to use for Amazon S3 Storage Lens export.
    account_id str
    The AWS account ID that owns the destination S3 bucket.
    arn str
    The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.
    format StorageLensS3BucketDestinationFormat
    Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.
    output_schema_version StorageLensS3BucketDestinationOutputSchemaVersion
    The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.
    encryption StorageLensEncryption
    prefix str
    The prefix to use for Amazon S3 Storage Lens export.
    accountId String
    The AWS account ID that owns the destination S3 bucket.
    arn String
    The ARN of the bucket to which Amazon S3 Storage Lens exports will be placed.
    format "CSV" | "Parquet"
    Specifies the file format to use when exporting Amazon S3 Storage Lens metrics export.
    outputSchemaVersion "V_1"
    The version of the output schema to use when exporting Amazon S3 Storage Lens metrics.
    encryption Property Map
    prefix String
    The prefix to use for Amazon S3 Storage Lens export.

    StorageLensS3BucketDestinationFormat, StorageLensS3BucketDestinationFormatArgs

    Csv
    CSV
    Parquet
    Parquet
    StorageLensS3BucketDestinationFormatCsv
    CSV
    StorageLensS3BucketDestinationFormatParquet
    Parquet
    Csv
    CSV
    Parquet
    Parquet
    Csv
    CSV
    Parquet
    Parquet
    CSV
    CSV
    PARQUET
    Parquet
    "CSV"
    CSV
    "Parquet"
    Parquet

    StorageLensS3BucketDestinationOutputSchemaVersion, StorageLensS3BucketDestinationOutputSchemaVersionArgs

    V1
    V_1
    StorageLensS3BucketDestinationOutputSchemaVersionV1
    V_1
    V1
    V_1
    V1
    V_1
    V1
    V_1
    "V_1"
    V_1

    StorageLensSelectionCriteria, StorageLensSelectionCriteriaArgs

    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 double
    The minimum storage bytes threshold for the prefixes to be included in the analysis.
    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 float64
    The minimum storage bytes threshold for the prefixes to be included in the analysis.
    delimiter String
    Delimiter to divide S3 key into hierarchy of prefixes.
    maxDepth Integer
    Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.
    minStorageBytesPercentage Double
    The minimum storage bytes threshold for the prefixes to be included in the analysis.
    delimiter string
    Delimiter to divide S3 key into hierarchy of prefixes.
    maxDepth number
    Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.
    minStorageBytesPercentage number
    The minimum storage bytes threshold for the prefixes to be included in the analysis.
    delimiter str
    Delimiter to divide S3 key into hierarchy of prefixes.
    max_depth int
    Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.
    min_storage_bytes_percentage float
    The minimum storage bytes threshold for the prefixes to be included in the analysis.
    delimiter String
    Delimiter to divide S3 key into hierarchy of prefixes.
    maxDepth Number
    Max depth of prefixes of S3 key that Amazon S3 Storage Lens will analyze.
    minStorageBytesPercentage Number
    The minimum storage bytes threshold for the prefixes to be included in the analysis.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi