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
rtoInSecsandrpoInSecsof your resiliency policy. But, while assessing your application, the lowest possible assessment result is near zero. Hence, if you provide value zero forrtoInSecsandrpoInSecs, 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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceResiliencyPolicy.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ResiliencyPolicy.Builderbuilder()InstantcreationTime()Date and time when the resiliency policy was created.DataLocationConstraintdataLocationConstraint()Specifies a high-level geographical location constraint for where your resilience policy data can be stored.StringdataLocationConstraintAsString()Specifies a high-level geographical location constraint for where your resilience policy data can be stored.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)EstimatedCostTierestimatedCostTier()Specifies the estimated cost tier of the resiliency policy.StringestimatedCostTierAsString()Specifies the estimated cost tier of the resiliency policy.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasPolicy()For responses, this returns true if the service returned a value for the Policy property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Map<DisruptionType,FailurePolicy>policy()The resiliency policy.StringpolicyArn()Amazon Resource Name (ARN) of the resiliency policy.Map<String,FailurePolicy>policyAsStrings()The resiliency policy.StringpolicyDescription()The description for the policy.StringpolicyName()The name of the policyList<SdkField<?>>sdkFields()static Class<? extends ResiliencyPolicy.Builder>serializableBuilderClass()Map<String,String>tags()Tags assigned to the resource.ResiliencyPolicyTiertier()The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).StringtierAsString()The tier for this resiliency policy, ranging from the highest severity (MissionCritical) to lowest (NonCritical).ResiliencyPolicy.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
dataLocationConstraintwill returnDataLocationConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataLocationConstraintAsString().- Returns:
- Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
- See Also:
DataLocationConstraint
-
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,
dataLocationConstraintwill returnDataLocationConstraint.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataLocationConstraintAsString().- Returns:
- Specifies a high-level geographical location constraint for where your resilience policy data can be stored.
- See Also:
DataLocationConstraint
-
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,
estimatedCostTierwill returnEstimatedCostTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromestimatedCostTierAsString().- Returns:
- Specifies the estimated cost tier of the resiliency policy.
- See Also:
EstimatedCostTier
-
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,
estimatedCostTierwill returnEstimatedCostTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromestimatedCostTierAsString().- Returns:
- Specifies the estimated cost tier of the resiliency policy.
- See Also:
EstimatedCostTier
-
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 theisEmpty()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()
The description for the policy.
- Returns:
- The description for the 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 theisEmpty()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,
tierwill returnResiliencyPolicyTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtierAsString().- Returns:
- The tier for this resiliency policy, ranging from the highest severity (
MissionCritical) to lowest (NonCritical). - See Also:
ResiliencyPolicyTier
-
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,
tierwill returnResiliencyPolicyTier.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtierAsString().- Returns:
- The tier for this resiliency policy, ranging from the highest severity (
MissionCritical) to lowest (NonCritical). - See Also:
ResiliencyPolicyTier
-
toBuilder
public ResiliencyPolicy.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ResiliencyPolicy.Builder,ResiliencyPolicy>
-
builder
public static ResiliencyPolicy.Builder builder()
-
serializableBuilderClass
public static Class<? extends ResiliencyPolicy.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-