Package software.amazon.awssdk.services.resiliencehub.model

Class PutDraftAppVersionTemplateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.resiliencehub.model.ResiliencehubRequest

software.amazon.awssdk.services.resiliencehub.model.PutDraftAppVersionTemplateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutDraftAppVersionTemplateRequest.Builder,PutDraftAppVersionTemplateRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutDraftAppVersionTemplateRequest
extends ResiliencehubRequest
implements ToCopyableBuilder<PutDraftAppVersionTemplateRequest.Builder,PutDraftAppVersionTemplateRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutDraftAppVersionTemplateRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	appArn()	Amazon Resource Name (ARN) of the Resilience Hub application.
String	appTemplateBody()	A JSON string that provides information about your application structure.
static PutDraftAppVersionTemplateRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PutDraftAppVersionTemplateRequest.Builder>	serializableBuilderClass()
PutDraftAppVersionTemplateRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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>"}]}]"

toBuilder

public PutDraftAppVersionTemplateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutDraftAppVersionTemplateRequest.Builder,PutDraftAppVersionTemplateRequest>

Specified by:

toBuilder in class ResiliencehubRequest

builder

public static PutDraftAppVersionTemplateRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo