Interface StorageLensConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<StorageLensConfiguration.Builder,StorageLensConfiguration>, SdkBuilder<StorageLensConfiguration.Builder,StorageLensConfiguration>, SdkPojo
Enclosing class:
StorageLensConfiguration
@Mutable @NotThreadSafe public static interface StorageLensConfiguration.Builder extends SdkPojo, CopyableBuilder<StorageLensConfiguration.Builder,StorageLensConfiguration>

  • Method Details

    • id

      StorageLensConfiguration.Builder id(String id)

      A container for the Amazon S3 Storage Lens configuration ID.

      Parameters:
      id - A container for the Amazon S3 Storage Lens configuration ID.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountLevel

      StorageLensConfiguration.Builder accountLevel(AccountLevel accountLevel)

      A container for all the account-level configurations of your S3 Storage Lens configuration.

      Parameters:
      accountLevel - A container for all the account-level configurations of your S3 Storage Lens configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountLevel

      default StorageLensConfiguration.Builder accountLevel(Consumer<AccountLevel.Builder> accountLevel)

      A container for all the account-level configurations of your S3 Storage Lens configuration.

      This is a convenience method that creates an instance of the AccountLevel.Builder avoiding the need to create one manually via AccountLevel.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to accountLevel(AccountLevel).

      Parameters:
      accountLevel - a consumer that will call methods on AccountLevel.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • include

      StorageLensConfiguration.Builder include(Include include)

      A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.

      Parameters:
      include - A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • include

      default StorageLensConfiguration.Builder include(Consumer<Include.Builder> include)

      A container for what is included in this configuration. This container can only be valid if there is no Exclude container submitted, and it's not empty.

      This is a convenience method that creates an instance of the Include.Builder avoiding the need to create one manually via Include.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to include(Include).

      Parameters:
      include - a consumer that will call methods on Include.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • exclude

      StorageLensConfiguration.Builder exclude(Exclude exclude)

      A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.

      Parameters:
      exclude - A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exclude

      default StorageLensConfiguration.Builder exclude(Consumer<Exclude.Builder> exclude)

      A container for what is excluded in this configuration. This container can only be valid if there is no Include container submitted, and it's not empty.

      This is a convenience method that creates an instance of the Exclude.Builder avoiding the need to create one manually via Exclude.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to exclude(Exclude).

      Parameters:
      exclude - a consumer that will call methods on Exclude.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataExport

      StorageLensConfiguration.Builder dataExport(StorageLensDataExport dataExport)

      A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

      Parameters:
      dataExport - A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataExport

      default StorageLensConfiguration.Builder dataExport(Consumer<StorageLensDataExport.Builder> dataExport)

      A container to specify the properties of your S3 Storage Lens metrics export including, the destination, schema and format.

      This is a convenience method that creates an instance of the StorageLensDataExport.Builder avoiding the need to create one manually via StorageLensDataExport.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataExport(StorageLensDataExport).

      Parameters:
      dataExport - a consumer that will call methods on StorageLensDataExport.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • expandedPrefixesDataExport

      StorageLensConfiguration.Builder expandedPrefixesDataExport(StorageLensExpandedPrefixesDataExport expandedPrefixesDataExport)

      A container that configures your S3 Storage Lens expanded prefixes metrics report.

      Parameters:
      expandedPrefixesDataExport - A container that configures your S3 Storage Lens expanded prefixes metrics report.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expandedPrefixesDataExport

      default StorageLensConfiguration.Builder expandedPrefixesDataExport(Consumer<StorageLensExpandedPrefixesDataExport.Builder> expandedPrefixesDataExport)

      A container that configures your S3 Storage Lens expanded prefixes metrics report.

      This is a convenience method that creates an instance of the StorageLensExpandedPrefixesDataExport.Builder avoiding the need to create one manually via StorageLensExpandedPrefixesDataExport.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to expandedPrefixesDataExport(StorageLensExpandedPrefixesDataExport).

      Parameters:
      expandedPrefixesDataExport - a consumer that will call methods on StorageLensExpandedPrefixesDataExport.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • isEnabled

      StorageLensConfiguration.Builder isEnabled(Boolean isEnabled)

      A container for whether the S3 Storage Lens configuration is enabled.

      Parameters:
      isEnabled - A container for whether the S3 Storage Lens configuration is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • awsOrg

      StorageLensConfiguration.Builder awsOrg(StorageLensAwsOrg awsOrg)

      A container for the Amazon Web Services organization for this S3 Storage Lens configuration.

      Parameters:
      awsOrg - A container for the Amazon Web Services organization for this S3 Storage Lens configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • awsOrg

      default StorageLensConfiguration.Builder awsOrg(Consumer<StorageLensAwsOrg.Builder> awsOrg)

      A container for the Amazon Web Services organization for this S3 Storage Lens configuration.

      This is a convenience method that creates an instance of the StorageLensAwsOrg.Builder avoiding the need to create one manually via StorageLensAwsOrg.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to awsOrg(StorageLensAwsOrg).

      Parameters:
      awsOrg - a consumer that will call methods on StorageLensAwsOrg.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • storageLensArn

      StorageLensConfiguration.Builder storageLensArn(String storageLensArn)

      The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name

      Parameters:
      storageLensArn - The Amazon Resource Name (ARN) of the S3 Storage Lens configuration. This property is read-only and follows the following format: arn:aws:s3:us-east-1:example-account-id:storage-lens/your-dashboard-name
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • prefixDelimiter

      StorageLensConfiguration.Builder prefixDelimiter(String prefixDelimiter)

      A container for all prefix delimiters that are used for object keys in this S3 Storage Lens configuration. The prefix delimiters determine how S3 Storage Lens counts prefix depth, by separating the hierarchical levels in object keys.

      • If either a prefix delimiter or existing delimiter is undefined, Amazon S3 uses the delimiter that’s defined.

      • If both the prefix delimiter and existing delimiter are undefined, S3 uses / as the default delimiter.

      • When custom delimiters are used, both the prefix delimiter and existing delimiter must specify the same special character. Otherwise, your request results in an error.

      Parameters:
      prefixDelimiter - A container for all prefix delimiters that are used for object keys in this S3 Storage Lens configuration. The prefix delimiters determine how S3 Storage Lens counts prefix depth, by separating the hierarchical levels in object keys.

      • If either a prefix delimiter or existing delimiter is undefined, Amazon S3 uses the delimiter that’s defined.

      • If both the prefix delimiter and existing delimiter are undefined, S3 uses / as the default delimiter.

      • When custom delimiters are used, both the prefix delimiter and existing delimiter must specify the same special character. Otherwise, your request results in an error.

      Returns:
      Returns a reference to this object so that method calls can be chained together.