Class DescribeAppVersionTemplateResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.resiliencehub.model.ResiliencehubResponse
software.amazon.awssdk.services.resiliencehub.model.DescribeAppVersionTemplateResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAppVersionTemplateResponse.Builder,DescribeAppVersionTemplateResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAppVersionTemplateResponse extends ResiliencehubResponse implements ToCopyableBuilder<DescribeAppVersionTemplateResponse.Builder,DescribeAppVersionTemplateResponse>

  • Method Details

    • appArn

      public final String appArn()

      Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn: partition:resiliencehub:region:account:app/app-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 Resilience Hub application. The format for this ARN is: arn: partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

    • appTemplateBody

      public final String appTemplateBody()

      A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

      The appTemplateBody JSON string has the following structure:

      • resources

        The list of logical resources that must be included in the Resilience Hub application.

        Type: Array

        Don't add the resources that you want to exclude.

        Each resources array item includes the following fields:

        • logicalResourceId

          Logical identifier of the resource.

          Type: Object

          Each logicalResourceId object includes the following fields:

          • identifier

            Identifier of the resource.

            Type: String

          • logicalStackName

            The name of the CloudFormation stack this resource belongs to.

            Type: String

          • resourceGroupName

            The name of the resource group this resource belongs to.

            Type: String

          • terraformSourceName

            The name of the Terraform S3 state file this resource belongs to.

            Type: String

          • eksSourceName

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            This parameter accepts values in "eks-cluster/namespace" format.

            Type: String

        • type

          The type of resource.

          Type: string

        • name

          The name of the resource.

          Type: String

        • additionalInfo

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

          Key: "failover-regions"

          Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

      • appComponents

        List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

        Type: Array

        Each appComponents array item includes the following fields:

        • name

          Name of the Application Component.

          Type: String

        • type

          Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

          Type: String

        • resourceNames

          The list of included resources that are assigned to the Application Component.

          Type: Array of strings

        • additionalInfo

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

          Key: "failover-regions"

          Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

      • excludedResources

        The list of logical resource identifiers to be excluded from the application.

        Type: Array

        Don't add the resources that you want to include.

        Each excludedResources array item includes the following fields:

        • logicalResourceIds

          Logical identifier of the resource.

          Type: Object

          You can configure only one of the following fields:

          • logicalStackName

          • resourceGroupName

          • terraformSourceName

          • eksSourceName

          Each logicalResourceIds object includes the following fields:

          • identifier

            Identifier of the resource.

            Type: String

          • logicalStackName

            The name of the CloudFormation stack this resource belongs to.

            Type: String

          • resourceGroupName

            The name of the resource group this resource belongs to.

            Type: String

          • terraformSourceName

            The name of the Terraform S3 state file this resource belongs to.

            Type: String

          • eksSourceName

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            This parameter accepts values in "eks-cluster/namespace" format.

            Type: String

      • version

        Resilience Hub application version.

      • additionalInfo

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

      Returns:
      A JSON string that provides information about your application structure. To learn more about the appTemplateBody template, see the sample template provided in the Examples section.

      The appTemplateBody JSON string has the following structure:

      • resources

        The list of logical resources that must be included in the Resilience Hub application.

        Type: Array

        Don't add the resources that you want to exclude.

        Each resources array item includes the following fields:

        • logicalResourceId

          Logical identifier of the resource.

          Type: Object

          Each logicalResourceId object includes the following fields:

          • identifier

            Identifier of the resource.

            Type: String

          • logicalStackName

            The name of the CloudFormation stack this resource belongs to.

            Type: String

          • resourceGroupName

            The name of the resource group this resource belongs to.

            Type: String

          • terraformSourceName

            The name of the Terraform S3 state file this resource belongs to.

            Type: String

          • eksSourceName

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            This parameter accepts values in "eks-cluster/namespace" format.

            Type: String

        • type

          The type of resource.

          Type: string

        • name

          The name of the resource.

          Type: String

        • additionalInfo

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

          Key: "failover-regions"

          Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

      • appComponents

        List of Application Components that this resource belongs to. If an Application Component is not part of the Resilience Hub application, it will be added.

        Type: Array

        Each appComponents array item includes the following fields:

        • name

          Name of the Application Component.

          Type: String

        • type

          Type of Application Component. For more information about the types of Application Component, see Grouping resources in an AppComponent.

          Type: String

        • resourceNames

          The list of included resources that are assigned to the Application Component.

          Type: Array of strings

        • additionalInfo

          Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

          Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

          Key: "failover-regions"

          Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

      • excludedResources

        The list of logical resource identifiers to be excluded from the application.

        Type: Array

        Don't add the resources that you want to include.

        Each excludedResources array item includes the following fields:

        • logicalResourceIds

          Logical identifier of the resource.

          Type: Object

          You can configure only one of the following fields:

          • logicalStackName

          • resourceGroupName

          • terraformSourceName

          • eksSourceName

          Each logicalResourceIds object includes the following fields:

          • identifier

            Identifier of the resource.

            Type: String

          • logicalStackName

            The name of the CloudFormation stack this resource belongs to.

            Type: String

          • resourceGroupName

            The name of the resource group this resource belongs to.

            Type: String

          • terraformSourceName

            The name of the Terraform S3 state file this resource belongs to.

            Type: String

          • eksSourceName

            Name of the Amazon Elastic Kubernetes Service cluster and namespace this resource belongs to.

            This parameter accepts values in "eks-cluster/namespace" format.

            Type: String

      • version

        Resilience Hub application version.

      • additionalInfo

        Additional configuration parameters for an Resilience Hub application. If you want to implement additionalInfo through the Resilience Hub console rather than using an API call, see Configure the application configuration parameters.

        Currently, this parameter accepts a key-value mapping (in a string format) of only one failover region and one associated account.

        Key: "failover-regions"

        Value: "[{"region":"<REGION>", "accounts":[{"id":"<ACCOUNT_ID>"}]}]"

    • appVersion

      public final String appVersion()

      The version of the application.

      Returns:
      The version of the application.

    • toBuilder

      public DescribeAppVersionTemplateResponse.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<DescribeAppVersionTemplateResponse.Builder,DescribeAppVersionTemplateResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeAppVersionTemplateResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.