Package software.amazon.smithy.aws.cloudformation.schema.model

Class ResourceSchema

java.lang.Object

software.amazon.smithy.aws.cloudformation.schema.model.ResourceSchema

All Implemented Interfaces:

ToNode, ToSmithyBuilder<ResourceSchema>

public final class ResourceSchema
extends Object
implements ToNode, ToSmithyBuilder<ResourceSchema>

Data class representing a CloudFormation Resource Schema.

See Also:

• Resource Type Schema
• Resource Type JSON Schema

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ResourceSchema.Builder

Method Summary

Modifier and Type	Method	Description
static ResourceSchema.Builder	builder()
List<List<String>>	getAdditionalIdentifiers()
Set<String>	getCreateOnlyProperties()
Map<String,Schema>	getDefinitions()
Set<String>	getDeprecatedProperties()
String	getDescription()
Optional<String>	getDocumentationUrl()
Map<String,Handler>	getHandlers()
Set<String>	getPrimaryIdentifier()
Map<String,Property>	getProperties()
Set<String>	getReadOnlyProperties()
Map<String,Remote>	getRemotes()
Optional<String>	getSourceUrl()
Tagging	getTagging()
String	getTypeName()
Set<String>	getWriteOnlyProperties()
ResourceSchema.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
Node	toNode()	Converts a value to a Node.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

toNode

public Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

toBuilder

public ResourceSchema.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<ResourceSchema>

Returns:

a builder for type T

builder

public static ResourceSchema.Builder builder()

getTypeName

public String getTypeName()

getDescription

public String getDescription()

getSourceUrl

public Optional<String> getSourceUrl()

getDocumentationUrl

public Optional<String> getDocumentationUrl()

getDefinitions

public Map<String,Schema> getDefinitions()

getProperties

public Map<String,Property> getProperties()

getReadOnlyProperties

public Set<String> getReadOnlyProperties()

getWriteOnlyProperties

public Set<String> getWriteOnlyProperties()

getPrimaryIdentifier

public Set<String> getPrimaryIdentifier()

getCreateOnlyProperties

public Set<String> getCreateOnlyProperties()

getDeprecatedProperties

public Set<String> getDeprecatedProperties()

getAdditionalIdentifiers

public List<List<String>> getAdditionalIdentifiers()

getHandlers

public Map<String,Handler> getHandlers()

getRemotes

public Map<String,Remote> getRemotes()

getTagging

public Tagging getTagging()