PhysicalResource (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.resiliencehub.model.PhysicalResource

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PhysicalResource
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Defines a physical resource. A physical resource is a resource that exists in your account. It can be identified using an Amazon Resource Name (ARN) or an Resilience Hub-native identifier.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PhysicalResource()

Constructors
Constructor and Description
`PhysicalResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PhysicalResource`	`addAdditionalInfoEntry(String key, List<String> value)` Add a single AdditionalInfo entry
`PhysicalResource`	`clearAdditionalInfoEntries()` Removes all the entries added into AdditionalInfo.
`PhysicalResource`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,List<String>>`	`getAdditionalInfo()` Additional configuration parameters for an Resilience Hub application.
`List<AppComponent>`	`getAppComponents()` The application components that belong to this resource.
`Boolean`	`getExcluded()` Indicates if a resource is included or excluded from the assessment.
`LogicalResourceId`	`getLogicalResourceId()` The logical identifier of the resource.
`PhysicalResourceId`	`getPhysicalResourceId()` The physical identifier of the resource.
`String`	`getResourceName()` The name of the resource.
`String`	`getResourceType()` The type of resource.
`int`	`hashCode()`
`Boolean`	`isExcluded()` Indicates if a resource is included or excluded from the assessment.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalInfo(Map<String,List<String>> additionalInfo)` Additional configuration parameters for an Resilience Hub application.
`void`	`setAppComponents(Collection<AppComponent> appComponents)` The application components that belong to this resource.
`void`	`setExcluded(Boolean excluded)` Indicates if a resource is included or excluded from the assessment.
`void`	`setLogicalResourceId(LogicalResourceId logicalResourceId)` The logical identifier of the resource.
`void`	`setPhysicalResourceId(PhysicalResourceId physicalResourceId)` The physical identifier of the resource.
`void`	`setResourceName(String resourceName)` The name of the resource.
`void`	`setResourceType(String resourceType)` The type of resource.
`String`	`toString()` Returns a string representation of this object.
`PhysicalResource`	`withAdditionalInfo(Map<String,List<String>> additionalInfo)` Additional configuration parameters for an Resilience Hub application.
`PhysicalResource`	`withAppComponents(AppComponent... appComponents)` The application components that belong to this resource.
`PhysicalResource`	`withAppComponents(Collection<AppComponent> appComponents)` The application components that belong to this resource.
`PhysicalResource`	`withExcluded(Boolean excluded)` Indicates if a resource is included or excluded from the assessment.
`PhysicalResource`	`withLogicalResourceId(LogicalResourceId logicalResourceId)` The logical identifier of the resource.
`PhysicalResource`	`withPhysicalResourceId(PhysicalResourceId physicalResourceId)` The physical identifier of the resource.
`PhysicalResource`	`withResourceName(String resourceName)` The name of the resource.
`PhysicalResource`	`withResourceType(String resourceType)` The type of resource.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PhysicalResource
```
public PhysicalResource()
```
- Method Detail
  - getAdditionalInfo
```
public Map<String,List<String>> getAdditionalInfo()
```
    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:
    
    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>"}]}]"
  - setAdditionalInfo
```
public void setAdditionalInfo(Map<String,List<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>"}]}]"
    
    Parameters:
    
    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>"}]}]"
  - withAdditionalInfo
```
public PhysicalResource withAdditionalInfo(Map<String,List<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>"}]}]"
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAdditionalInfoEntry
```
public PhysicalResource addAdditionalInfoEntry(String key,
                                               List<String> value)
```
    Add a single AdditionalInfo entry
    
    See Also:
    
    withAdditionalInfo(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - clearAdditionalInfoEntries
```
public PhysicalResource clearAdditionalInfoEntries()
```
    Removes all the entries added into AdditionalInfo.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAppComponents
```
public List<AppComponent> getAppComponents()
```
    The application components that belong to this resource.
    
    Returns:
    
    The application components that belong to this resource.
  - setAppComponents
```
public void setAppComponents(Collection<AppComponent> appComponents)
```
    The application components that belong to this resource.
    
    Parameters:
    
    appComponents - The application components that belong to this resource.
  - withAppComponents
```
public PhysicalResource withAppComponents(AppComponent... appComponents)
```
    The application components that belong to this resource.
    
    NOTE: This method appends the values to the existing list (if any). Use setAppComponents(java.util.Collection) or withAppComponents(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    appComponents - The application components that belong to this resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAppComponents
```
public PhysicalResource withAppComponents(Collection<AppComponent> appComponents)
```
    The application components that belong to this resource.
    
    Parameters:
    
    appComponents - The application components that belong to this resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExcluded
```
public void setExcluded(Boolean excluded)
```
    Indicates if a resource is included or excluded from the assessment.
    
    Parameters:
    
    excluded - Indicates if a resource is included or excluded from the assessment.
  - getExcluded
```
public Boolean getExcluded()
```
    Indicates if a resource is included or excluded from the assessment.
    
    Returns:
    
    Indicates if a resource is included or excluded from the assessment.
  - withExcluded
```
public PhysicalResource withExcluded(Boolean excluded)
```
    Indicates if a resource is included or excluded from the assessment.
    
    Parameters:
    
    excluded - Indicates if a resource is included or excluded from the assessment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExcluded
```
public Boolean isExcluded()
```
    Indicates if a resource is included or excluded from the assessment.
    
    Returns:
    
    Indicates if a resource is included or excluded from the assessment.
  - setLogicalResourceId
```
public void setLogicalResourceId(LogicalResourceId logicalResourceId)
```
    The logical identifier of the resource.
    
    Parameters:
    
    logicalResourceId - The logical identifier of the resource.
  - getLogicalResourceId
```
public LogicalResourceId getLogicalResourceId()
```
    The logical identifier of the resource.
    
    Returns:
    
    The logical identifier of the resource.
  - withLogicalResourceId
```
public PhysicalResource withLogicalResourceId(LogicalResourceId logicalResourceId)
```
    The logical identifier of the resource.
    
    Parameters:
    
    logicalResourceId - The logical identifier of the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPhysicalResourceId
```
public void setPhysicalResourceId(PhysicalResourceId physicalResourceId)
```
    The physical identifier of the resource.
    
    Parameters:
    
    physicalResourceId - The physical identifier of the resource.
  - getPhysicalResourceId
```
public PhysicalResourceId getPhysicalResourceId()
```
    The physical identifier of the resource.
    
    Returns:
    
    The physical identifier of the resource.
  - withPhysicalResourceId
```
public PhysicalResource withPhysicalResourceId(PhysicalResourceId physicalResourceId)
```
    The physical identifier of the resource.
    
    Parameters:
    
    physicalResourceId - The physical identifier of the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceName
```
public void setResourceName(String resourceName)
```
    The name of the resource.
    
    Parameters:
    
    resourceName - The name of the resource.
  - getResourceName
```
public String getResourceName()
```
    The name of the resource.
    
    Returns:
    
    The name of the resource.
  - withResourceName
```
public PhysicalResource withResourceName(String resourceName)
```
    The name of the resource.
    
    Parameters:
    
    resourceName - The name of the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The type of resource.
    
    Parameters:
    
    resourceType - The type of resource.
  - getResourceType
```
public String getResourceType()
```
    The type of resource.
    
    Returns:
    
    The type of resource.
  - withResourceType
```
public PhysicalResource withResourceType(String resourceType)
```
    The type of resource.
    
    Parameters:
    
    resourceType - The type of resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PhysicalResource clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PhysicalResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PhysicalResource

Method Detail

getAdditionalInfo

setAdditionalInfo

withAdditionalInfo

addAdditionalInfoEntry

clearAdditionalInfoEntries

getAppComponents

setAppComponents

withAppComponents

withAppComponents

setExcluded

getExcluded

withExcluded

isExcluded

setLogicalResourceId

getLogicalResourceId

withLogicalResourceId

setPhysicalResourceId

getPhysicalResourceId

withPhysicalResourceId

setResourceName

getResourceName

withResourceName

setResourceType

getResourceType

withResourceType

toString

equals

hashCode

clone

marshall