software.amazon.smithy.aws.cloudformation.schema.fromsmithy

Class Context

java.lang.Object

software.amazon.smithy.aws.cloudformation.schema.fromsmithy.Context

public final class Context
extends java.lang.Object

Smithy to CloudFormation conversion context object.

One context is used per CloudFormation resource generated.

Method Summary

Modifier and Type	Method and Description
CfnResource	getCfnResource() Gets the CfnResource index data for this resource.
CfnConfig	getConfig() Gets the configuration object used for the conversion.
JsonSchemaConverter	getJsonSchemaConverter() Gets the JSON schema converter.
Model	getModel() Gets the Smithy model being converted.
java.lang.String	getPropertyPointer(java.lang.String propertyName) Gets the JSON pointer string to a specific property.
ResourceShape	getResource() Gets the resource shape being converted.
StructureShape	getResourceStructure() Gets the structure shape that represents the consolidated properties of the resource.
ServiceShape	getService() Gets the service shape containing the resource being converted.

Methods inherited from class java.lang.Object

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

Method Detail

getModel

public Model getModel()

Gets the Smithy model being converted.

Returns:

Returns the Smithy model.

getService

public ServiceShape getService()

Gets the service shape containing the resource being converted.

Returns:

Returns the service shape.

getResource

public ResourceShape getResource()

Gets the resource shape being converted.

Returns:

Returns the resource shape.

getCfnResource

public CfnResource getCfnResource()

Gets the CfnResource index data for this resource.

Returns:

Returns the CfnResource index data.

getResourceStructure

public StructureShape getResourceStructure()

Gets the structure shape that represents the consolidated properties of the resource.

Returns:

Returns the structure shape.

getConfig

public CfnConfig getConfig()

Gets the configuration object used for the conversion.

Plugins can query this object for configuration values.

Returns:

Returns the configuration object.

getJsonSchemaConverter

public JsonSchemaConverter getJsonSchemaConverter()

Gets the JSON schema converter.

Returns:

Returns the JSON Schema converter.

getPropertyPointer

public java.lang.String getPropertyPointer(java.lang.String propertyName)

Gets the JSON pointer string to a specific property.

Parameters:

propertyName - Property name to build a JSON pointer to.

Returns:

Returns the JSON pointer to the property.