Package software.amazon.awssdk.services.opsworkscm.model

Class ExportServerEngineAttributeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opsworkscm.model.OpsWorksCmRequest

software.amazon.awssdk.services.opsworkscm.model.ExportServerEngineAttributeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ExportServerEngineAttributeRequest.Builder,ExportServerEngineAttributeRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ExportServerEngineAttributeRequest
extends OpsWorksCmRequest
implements ToCopyableBuilder<ExportServerEngineAttributeRequest.Builder,ExportServerEngineAttributeRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ExportServerEngineAttributeRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ExportServerEngineAttributeRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	exportAttributeName()	The name of the export attribute.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputAttributes()	For responses, this returns true if the service returned a value for the InputAttributes property.
List<EngineAttribute>	inputAttributes()	The list of engine attributes.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ExportServerEngineAttributeRequest.Builder>	serializableBuilderClass()
String	serverName()	The name of the server from which you are exporting the attribute.
ExportServerEngineAttributeRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

exportAttributeName

public final String exportAttributeName()

The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list.

Returns:

The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list.

serverName

public final String serverName()

The name of the server from which you are exporting the attribute.

Returns:

The name of the server from which you are exporting the attribute.

hasInputAttributes

public final boolean hasInputAttributes()

For responses, this returns true if the service returned a value for the InputAttributes 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.

inputAttributes

public final List<EngineAttribute> inputAttributes()

The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names.

• RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.

• OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored.

• NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.

• NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.

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

Returns:

The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names.

• RunList In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.

• OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored.

• NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.

• NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.

toBuilder

public ExportServerEngineAttributeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ExportServerEngineAttributeRequest.Builder,ExportServerEngineAttributeRequest>

Specified by:

toBuilder in class OpsWorksCmRequest

builder

public static ExportServerEngineAttributeRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo