Interface PutLifecycleConfigurationRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutLifecycleConfigurationRequest.Builder,PutLifecycleConfigurationRequest>, EfsRequest.Builder, SdkBuilder<PutLifecycleConfigurationRequest.Builder,PutLifecycleConfigurationRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutLifecycleConfigurationRequest
public static interface PutLifecycleConfigurationRequest.Builder extends EfsRequest.Builder, SdkPojo, CopyableBuilder<PutLifecycleConfigurationRequest.Builder,PutLifecycleConfigurationRequest>

  • Method Details

    • fileSystemId

      PutLifecycleConfigurationRequest.Builder fileSystemId(String fileSystemId)

      The ID of the file system for which you are creating the LifecycleConfiguration object (String).

      Parameters:
      fileSystemId - The ID of the file system for which you are creating the LifecycleConfiguration object (String).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lifecyclePolicies

      PutLifecycleConfigurationRequest.Builder lifecyclePolicies(Collection<LifecyclePolicy> lifecyclePolicies)

      An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS Lifecycle management of the following:

      • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

      • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

        File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

        The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.

      • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

      When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each storage transition. See the example requests in the following section for more information.

      Parameters:
      lifecyclePolicies - An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS Lifecycle management of the following:

      • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

      • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

        File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

        The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.

      • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

      When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each storage transition. See the example requests in the following section for more information.

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

    • lifecyclePolicies

      PutLifecycleConfigurationRequest.Builder lifecyclePolicies(LifecyclePolicy... lifecyclePolicies)

      An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS Lifecycle management of the following:

      • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

      • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

        File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

        The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.

      • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

      When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each storage transition. See the example requests in the following section for more information.

      Parameters:
      lifecyclePolicies - An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS Lifecycle management of the following:

      • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

      • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

        File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

        The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.

      • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

      When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each storage transition. See the example requests in the following section for more information.

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

    • lifecyclePolicies

      PutLifecycleConfigurationRequest.Builder lifecyclePolicies(Consumer<LifecyclePolicy.Builder>... lifecyclePolicies)

      An array of LifecyclePolicy objects that define the file system's LifecycleConfiguration object. A LifecycleConfiguration object informs EFS Lifecycle management of the following:

      • TransitionToIA – When to move files in the file system from primary storage (Standard storage class) into the Infrequent Access (IA) storage.

      • TransitionToArchive – When to move files in the file system from their current storage class (either IA or Standard storage) into the Archive storage.

        File systems cannot transition into Archive storage before transitioning into IA storage. Therefore, TransitionToArchive must either not be set or must be later than TransitionToIA.

        The Archive storage class is available only for file systems that use the Elastic Throughput mode and the General Purpose Performance mode.

      • TransitionToPrimaryStorageClass – Whether to move files in the file system back to primary storage (Standard storage class) after they are accessed in IA or Archive storage.

      When using the put-lifecycle-configuration CLI command or the PutLifecycleConfiguration API action, Amazon EFS requires that each LifecyclePolicy object have only a single transition. This means that in a request body, LifecyclePolicies must be structured as an array of LifecyclePolicy objects, one object for each storage transition. See the example requests in the following section for more information.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lifecyclePolicies(List<LifecyclePolicy>).

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

    • overrideConfiguration

      PutLifecycleConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutLifecycleConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.