Package software.amazon.awssdk.services.controltower.model

Class EnableControlRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.controltower.model.ControlTowerRequest

software.amazon.awssdk.services.controltower.model.EnableControlRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<EnableControlRequest.Builder,EnableControlRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EnableControlRequest.Builder

Method Summary

Modifier and Type	Method	Description
static EnableControlRequest.Builder	builder()
String	controlIdentifier()	The ARN of the control.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<EnabledControlParameter>	parameters()	A list of input parameter values, which are specified to configure the control when you enable it.
List<SdkField<?>>	sdkFields()
static Class<? extends EnableControlRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Tags to be applied to the EnabledControl resource.
String	targetIdentifier()	The ARN of the organizational unit.
EnableControlRequest.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

controlIdentifier

public final String controlIdentifier()

The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.

Returns:

The ARN of the control. Only Strongly recommended and Elective controls are permitted, with the exception of the Region deny control. For information on how to find the controlIdentifier, see the overview page.

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 List<EnabledControlParameter> parameters()

A list of input parameter values, which are specified to configure the control when you enable it.

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:

A list of input parameter values, which are specified to configure the control when you enable it.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

Tags to be applied to the EnabledControl resource.

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

Returns:

Tags to be applied to the EnabledControl resource.

targetIdentifier

public final String targetIdentifier()

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

Returns:

The ARN of the organizational unit. For information on how to find the targetIdentifier, see the overview page.

toBuilder

public EnableControlRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EnableControlRequest.Builder,EnableControlRequest>

Specified by:

toBuilder in class ControlTowerRequest

builder

public static EnableControlRequest.Builder builder()

serializableBuilderClass

public static Class<? extends EnableControlRequest.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