Package software.amazon.awscdk.cfnpropertymixins.services.ssm

Class CfnDocumentMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.ssm.CfnDocumentMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnDocumentMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDocumentMixinProps

@Stability(Stable)
@Internal
public static final class CfnDocumentMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDocumentMixinProps

An implementation for CfnDocumentMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.ssm.CfnDocumentMixinProps

CfnDocumentMixinProps.Builder, CfnDocumentMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDocumentMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDocumentMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAttachments()	A list of key-value pairs that describe attachments to a version of a document.
final Object	getContent()	The content for the new SSM document in JSON or YAML.
final String	getDocumentFormat()	Specify the document format for the request.
final String	getDocumentType()	The type of document to create.
final String	getName()	A name for the SSM document.
final Object	getRequires()	A list of SSM documents required by a document.
final List<CfnTag>	getTags()	AWS CloudFormation resource tags to apply to the document.
final String	getTargetType()	Specify a target type to define the kinds of resources the document can run on.
final String	getUpdateMethod()	If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced.
final String	getVersionName()	An optional field specifying the version of the artifact you are creating with the document.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDocumentMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDocumentMixinProps.Builder.

Method Details

getAttachments

public final Object getAttachments()

Description copied from interface: CfnDocumentMixinProps

A list of key-value pairs that describe attachments to a version of a document.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDocumentPropsMixin.AttachmentsSourceProperty>

Specified by:

getAttachments in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-attachments

getContent

public final Object getContent()

Description copied from interface: CfnDocumentMixinProps

The content for the new SSM document in JSON or YAML.

For more information about the schemas for SSM document content, see SSM document schema features and examples in the AWS Systems Manager User Guide .

This parameter also supports String data types.

Specified by:

getContent in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content

getDocumentFormat

public final String getDocumentFormat()

Description copied from interface: CfnDocumentMixinProps

Specify the document format for the request.

JSON is the default format.

Default: - "JSON"

Specified by:

getDocumentFormat in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documentformat

getDocumentType

public final String getDocumentType()

Description copied from interface: CfnDocumentMixinProps

The type of document to create.

Specified by:

getDocumentType in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype

getName

public final String getName()

Description copied from interface: CfnDocumentMixinProps

A name for the SSM document.

You can't use the following strings as document name prefixes. These are reserved by AWS for use as document name prefixes:

• aws
• amazon
• amzn
• AWSEC2
• AWSConfigRemediation
• AWSSupport

Specified by:

getName in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-name

getRequires

public final Object getRequires()

Description copied from interface: CfnDocumentMixinProps

A list of SSM documents required by a document.

This parameter is used exclusively by AWS AppConfig . When a user creates an AWS AppConfig configuration in an SSM document, the user must also specify a required document for validation purposes. In this case, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document for validation purposes. For more information, see What is AWS AppConfig ? in the AWS AppConfig User Guide .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDocumentPropsMixin.DocumentRequiresProperty>

Specified by:

getRequires in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-requires

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnDocumentMixinProps

AWS CloudFormation resource tags to apply to the document.

Use tags to help you identify and categorize resources.

Specified by:

getTags in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags

getTargetType

public final String getTargetType()

Description copied from interface: CfnDocumentMixinProps

Specify a target type to define the kinds of resources the document can run on.

For example, to run a document on EC2 instances, specify the following value: /AWS::EC2::Instance . If you specify a value of '/' the document can run on all types of resources. If you don't specify a value, the document can't run on any resources. For a list of valid resource types, see AWS resource and property types reference in the AWS CloudFormation User Guide .

Specified by:

getTargetType in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-targettype

getUpdateMethod

public final String getUpdateMethod()

Description copied from interface: CfnDocumentMixinProps

If the document resource you specify in your template already exists, this parameter determines whether a new version of the existing document is created, or the existing document is replaced.

Replace is the default method. If you specify NewVersion for the UpdateMethod parameter, and the Name of the document does not match an existing resource, a new document is created. When you specify NewVersion , the default version of the document is changed to the newly created version.

Default: - "Replace"

Specified by:

getUpdateMethod in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-updatemethod

getVersionName

public final String getVersionName()

Description copied from interface: CfnDocumentMixinProps

An optional field specifying the version of the artifact you are creating with the document.

For example, Release12.1 . This value is unique across all versions of a document, and can't be changed.

Specified by:

getVersionName in interface CfnDocumentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-versionname

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object