Package software.amazon.awssdk.services.dlm.model

Class CreateLifecyclePolicyRequest

    • Method Detail

      • executionRoleArn

        public final String executionRoleArn()

        The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

        Returns:
        The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

      • description

        public final String description()

        A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

        Returns:
        A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

      • policyDetails

        public final PolicyDetails policyDetails()

        The configuration details of the lifecycle policy.

        If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

        Returns:
        The configuration details of the lifecycle policy.

        If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final Map<String,​String> tags()

        The tags to apply to the lifecycle policy during creation.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

        Returns:
        The tags to apply to the lifecycle policy during creation.

      • defaultPolicy

        public final DefaultPolicyTypeValues defaultPolicy()

        [Default policies only] Specify the type of default policy to create.

        • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

        • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

        If the service returns an enum value that is not available in the current SDK version, defaultPolicy will return DefaultPolicyTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultPolicyAsString().

        Returns:
        [Default policies only] Specify the type of default policy to create.

        • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

        • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

        See Also:
        DefaultPolicyTypeValues

      • defaultPolicyAsString

        public final String defaultPolicyAsString()

        [Default policies only] Specify the type of default policy to create.

        • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

        • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

        If the service returns an enum value that is not available in the current SDK version, defaultPolicy will return DefaultPolicyTypeValues.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultPolicyAsString().

        Returns:
        [Default policies only] Specify the type of default policy to create.

        • To create a default policy for EBS snapshots, that creates snapshots of all volumes in the Region that do not have recent backups, specify VOLUME.

        • To create a default policy for EBS-backed AMIs, that creates EBS-backed AMIs from all instances in the Region that do not have recent backups, specify INSTANCE.

        See Also:
        DefaultPolicyTypeValues

      • createInterval

        public final Integer createInterval()

        [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

        Default: 1

        Returns:
        [Default policies only] Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days. If you do not specify a value, the default is 1.

        Default: 1

      • retainInterval

        public final Integer retainInterval()

        [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

        Default: 7

        Returns:
        [Default policies only] Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time. If you do not specify a value, the default is 7.

        Default: 7

      • copyTags

        public final Boolean copyTags()

        [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

        Default: false

        Returns:
        [Default policies only] Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. If you do not specify a value, the default is false.

        Default: false

      • extendDeletion

        public final Boolean extendDeletion()

        [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

        By default (ExtendDeletion=false):

        • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

        • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

        If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

        If you do not specify a value, the default is false.

        Default: false

        Returns:
        [Default policies only] Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.

        By default (ExtendDeletion=false):

        • If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify true.

        • If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify true.

        If you enable extended deletion (ExtendDeletion=true), you override both default behaviors simultaneously.

        If you do not specify a value, the default is false.

        Default: false

      • hasCrossRegionCopyTargets

        public final boolean hasCrossRegionCopyTargets()
        For responses, this returns true if the service returned a value for the CrossRegionCopyTargets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • crossRegionCopyTargets

        public final List<CrossRegionCopyTarget> crossRegionCopyTargets()

        [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCrossRegionCopyTargets() method.

        Returns:
        [Default policies only] Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.

      • exclusions

        public final Exclusions exclusions()

        [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

        Returns:
        [Default policies only] Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object