software.amazon.awssdk.services.ssmincidents.model

Class SsmAutomation

java.lang.Object

software.amazon.awssdk.services.ssmincidents.model.SsmAutomation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SsmAutomation.Builder,SsmAutomation>

@Generated(value="software.amazon.awssdk:codegen")
public final class SsmAutomation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SsmAutomation.Builder,SsmAutomation>

Details about the Systems Manager automation document that will be used as a runbook during an incident.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SsmAutomation.Builder

Method Summary

Modifier and Type	Method and Description
static SsmAutomation.Builder	builder()
String	documentName() The automation document's name.
String	documentVersion() The automation document's version to use when running.
Map<String,DynamicSsmParameterValue>	dynamicParameters() The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDynamicParameters() For responses, this returns true if the service returned a value for the DynamicParameters property.
int	hashCode()
boolean	hasParameters() For responses, this returns true if the service returned a value for the Parameters property.
Map<String,List<String>>	parameters() The key-value pair parameters to use when running the automation document.
String	roleArn() The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
List<SdkField<?>>	sdkFields()
static Class<? extends SsmAutomation.Builder>	serializableBuilderClass()
SsmTargetAccount	targetAccount() The account that the automation document will be run in.
String	targetAccountAsString() The account that the automation document will be run in.
SsmAutomation.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

documentName

public final String documentName()

The automation document's name.

Returns:

The automation document's name.

documentVersion

public final String documentVersion()

The automation document's version to use when running.

Returns:

The automation document's version to use when running.

hasDynamicParameters

public final boolean hasDynamicParameters()

For responses, this returns true if the service returned a value for the DynamicParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

dynamicParameters

public final Map<String,DynamicSsmParameterValue> dynamicParameters()

The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

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 hasDynamicParameters() method.

Returns:

The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

parameters

public final Map<String,List<String>> parameters()

The key-value pair parameters to use when running the automation document.

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 hasParameters() method.

Returns:

The key-value pair parameters to use when running the automation document.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

Returns:

The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.

targetAccount

public final SsmTargetAccount targetAccount()

The account that the automation document will be run in. This can be in either the management account or an application account.

If the service returns an enum value that is not available in the current SDK version, targetAccount will return SsmTargetAccount.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetAccountAsString().

Returns:

The account that the automation document will be run in. This can be in either the management account or an application account.

See Also:

SsmTargetAccount

targetAccountAsString

public final String targetAccountAsString()

The account that the automation document will be run in. This can be in either the management account or an application account.

If the service returns an enum value that is not available in the current SDK version, targetAccount will return SsmTargetAccount.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from targetAccountAsString().

Returns:

The account that the automation document will be run in. This can be in either the management account or an application account.

See Also:

SsmTargetAccount

toBuilder

public SsmAutomation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SsmAutomation.Builder,SsmAutomation>

builder

public static SsmAutomation.Builder builder()

serializableBuilderClass

public static Class<? extends SsmAutomation.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo