Class ResiliencyPolicy

java.lang.Object
software.amazon.awssdk.services.resiliencehub.model.ResiliencyPolicy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ResiliencyPolicy.Builder,ResiliencyPolicy>
@Generated("software.amazon.awssdk:codegen") public final class ResiliencyPolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ResiliencyPolicy.Builder,ResiliencyPolicy>

Defines a resiliency policy.

Resilience Hub allows you to provide a value of zero for rtoInSecs and rpoInSecs of your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero for rtoInSecs and rpoInSecs, the estimated workload RTO and estimated workload RPO result will be near zero and the Compliance status for your application will be set to Policy breached.

See Also:

  • Method Details

    • creationTime

      public final Instant creationTime()

      Date and time when the resiliency policy was created.

      Returns:
      Date and time when the resiliency policy was created.

    • dataLocationConstraint

      public final DataLocationConstraint dataLocationConstraint()

      Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

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

      Returns:
      Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
      See Also:

    • dataLocationConstraintAsString

      public final String dataLocationConstraintAsString()

      Specifies a high-level geographical location constraint for where your resilience policy data can be stored.

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

      Returns:
      Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
      See Also:

    • estimatedCostTier

      public final EstimatedCostTier estimatedCostTier()

      Specifies the estimated cost tier of the resiliency policy.

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

      Returns:
      Specifies the estimated cost tier of the resiliency policy.
      See Also:

    • estimatedCostTierAsString

      public final String estimatedCostTierAsString()

      Specifies the estimated cost tier of the resiliency policy.

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

      Returns:
      Specifies the estimated cost tier of the resiliency policy.
      See Also:

    • policy

      public final Map<DisruptionType,FailurePolicy> policy()

      The resiliency policy.

      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 hasPolicy() method.

      Returns:
      The resiliency policy.

    • hasPolicy

      public final boolean hasPolicy()
      For responses, this returns true if the service returned a value for the Policy 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.

    • policyAsStrings

      public final Map<String,FailurePolicy> policyAsStrings()

      The resiliency policy.

      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 hasPolicy() method.

      Returns:
      The resiliency policy.

    • policyArn

      public final String policyArn()

      Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn:partition :resiliencehub:region:account:resiliency-policy/policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

      Returns:
      Amazon Resource Name (ARN) of the resiliency policy. The format for this ARN is: arn: partition:resiliencehub:region:account:resiliency-policy/ policy-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • policyDescription

      public final String policyDescription()

      Description of the resiliency policy.

      Returns:
      Description of the resiliency policy.

    • policyName

      public final String policyName()

      The name of the policy

      Returns:
      The name of the policy

    • 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()

      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

      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:
      Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

    • tier

      public final ResiliencyPolicyTier tier()

      The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest ( NonCritical).

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

      Returns:
      The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
      See Also:

    • tierAsString

      public final String tierAsString()

      The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest ( NonCritical).

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

      Returns:
      The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).
      See Also:

    • toBuilder

      public ResiliencyPolicy.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ResiliencyPolicy.Builder,ResiliencyPolicy>
      Returns:
      a builder for type T

    • builder

      public static ResiliencyPolicy.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ResiliencyPolicy.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.