com.monsanto.arch.cloudformation.model.resource
DocumentContent
Companion object DocumentContent
case class DocumentContent(schemaVersion: String, description: Option[Token[String]], parameters: Option[Map[String, DocumentParameter]], mainSteps: Option[Seq[DocumentStep]], assumeRole: Option[Token[String]] = None, outputs: Option[Seq[Token[String]]] = None) extends Product with Serializable
The syntax of your document is defined by the schema version used to create it. We recommended that you use schema version 2.2 or higher. Documents that use this schema version include the following top-level elements. For information about the properties that you can specify in these elements, see Top-level Elements in the Amazon EC2 Systems Manager API Reference.
- schemaVersion
The schema version to use.
- description
Information you provide to describe the purpose of the document.
- parameters
The parameters the document accepts. For parameters that you reference often, we recommend that you store those parameters in Systems Manager Parameter Store and then reference them. You can reference String and StringList Systems Manager parameters in this section of a document. You can't reference Secure String Systems Manager parameters in this section of a document. For more information, see Systems Manager Parameter Store.
- mainSteps
An object that can include multiple steps (plugins). Steps include one or more actions, an optional precondition, a unique name of the action, and inputs (parameters) for those actions. For a list of supported plugins and plugin properties, see SSM Plugins in the Amazon EC2 Systems Manager API Reference.
- assumeRole
The role that is assumed to run the automation
- outputs
Document outputs (used in automation documents)
- Alphabetic
- By Inheritance
- DocumentContent
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
DocumentContent(schemaVersion: String, description: Option[Token[String]], parameters: Option[Map[String, DocumentParameter]], mainSteps: Option[Seq[DocumentStep]], assumeRole: Option[Token[String]] = None, outputs: Option[Seq[Token[String]]] = None)
- schemaVersion
The schema version to use.
- description
Information you provide to describe the purpose of the document.
- parameters
The parameters the document accepts. For parameters that you reference often, we recommend that you store those parameters in Systems Manager Parameter Store and then reference them. You can reference String and StringList Systems Manager parameters in this section of a document. You can't reference Secure String Systems Manager parameters in this section of a document. For more information, see Systems Manager Parameter Store.
- mainSteps
An object that can include multiple steps (plugins). Steps include one or more actions, an optional precondition, a unique name of the action, and inputs (parameters) for those actions. For a list of supported plugins and plugin properties, see SSM Plugins in the Amazon EC2 Systems Manager API Reference.
- assumeRole
The role that is assumed to run the automation
- outputs
Document outputs (used in automation documents)
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val assumeRole: Option[Token[String]]
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- val description: Option[Token[String]]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val mainSteps: Option[Seq[DocumentStep]]
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val outputs: Option[Seq[Token[String]]]
- val parameters: Option[Map[String, DocumentParameter]]
- val schemaVersion: String
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )