Class ResourceDefinition
- java.lang.Object
-
- software.amazon.awssdk.services.cloudformation.model.ResourceDefinition
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ResourceDefinition.Builder,ResourceDefinition>
@Generated("software.amazon.awssdk:codegen") public final class ResourceDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ResourceDefinition.Builder,ResourceDefinition>
A resource included in a generated template. This data type is used with the
CreateGeneratedTemplate
andUpdateGeneratedTemplate
API actions.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ResourceDefinition.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ResourceDefinition.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasResourceIdentifier()
For responses, this returns true if the service returned a value for the ResourceIdentifier property.String
logicalResourceId()
The logical resource id for this resource in the generated template.Map<String,String>
resourceIdentifier()
A list of up to 256 key-value pairs that identifies the scanned resource.String
resourceType()
The type of the resource, such asAWS::DynamoDB::Table
.List<SdkField<?>>
sdkFields()
static Class<? extends ResourceDefinition.Builder>
serializableBuilderClass()
ResourceDefinition.Builder
toBuilder()
String
toString()
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
-
resourceType
public final String resourceType()
The type of the resource, such as
AWS::DynamoDB::Table
. For the list of supported resources, see IaC generator supported resource types in the CloudFormation User Guide- Returns:
- The type of the resource, such as
AWS::DynamoDB::Table
. For the list of supported resources, see IaC generator supported resource types in the CloudFormation User Guide
-
logicalResourceId
public final String logicalResourceId()
The logical resource id for this resource in the generated template.
- Returns:
- The logical resource id for this resource in the generated template.
-
hasResourceIdentifier
public final boolean hasResourceIdentifier()
For responses, this returns true if the service returned a value for the ResourceIdentifier 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.
-
resourceIdentifier
public final Map<String,String> resourceIdentifier()
A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the
primaryIdentifier
list in the resource schema.) The value is the value of that primary identifier. For example, for aAWS::DynamoDB::Table
resource, the primary identifiers isTableName
so the key-value pair could be"TableName": "MyDDBTable"
. For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.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
hasResourceIdentifier()
method.- Returns:
- A list of up to 256 key-value pairs that identifies the scanned resource. The key is the name of one of
the primary identifiers for the resource. (Primary identifiers are specified in the
primaryIdentifier
list in the resource schema.) The value is the value of that primary identifier. For example, for aAWS::DynamoDB::Table
resource, the primary identifiers isTableName
so the key-value pair could be"TableName": "MyDDBTable"
. For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.
-
toBuilder
public ResourceDefinition.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ResourceDefinition.Builder,ResourceDefinition>
-
builder
public static ResourceDefinition.Builder builder()
-
serializableBuilderClass
public static Class<? extends ResourceDefinition.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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.
-
-