Class Control
- java.lang.Object
-
- software.amazon.awssdk.services.auditmanager.model.Control
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Control.Builder,Control>
@Generated("software.amazon.awssdk:codegen") public final class Control extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Control.Builder,Control>
A control in Audit Manager.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceControl.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringactionPlanInstructions()The recommended actions to carry out if the control isn't fulfilled.StringactionPlanTitle()The title of the action plan for remediating the control.Stringarn()The Amazon Resource Name (ARN) of the control.static Control.Builderbuilder()List<ControlMappingSource>controlMappingSources()The data mapping sources for the control.StringcontrolSources()The data source types that determine where Audit Manager collects evidence from for the control.InstantcreatedAt()The time when the control was created.StringcreatedBy()The user or role that created the control.Stringdescription()The description of the control.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasControlMappingSources()For responses, this returns true if the service returned a value for the ControlMappingSources property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.Stringid()The unique identifier for the control.InstantlastUpdatedAt()The time when the control was most recently updated.StringlastUpdatedBy()The user or role that most recently updated the control.Stringname()The name of the control.List<SdkField<?>>sdkFields()static Class<? extends Control.Builder>serializableBuilderClass()ControlStatestate()The state of the control.StringstateAsString()The state of the control.Map<String,String>tags()The tags associated with the control.StringtestingInformation()The steps that you should follow to determine if the control has been satisfied.Control.BuildertoBuilder()StringtoString()Returns a string representation of this object.ControlTypetype()Specifies whether the control is a standard control or a custom control.StringtypeAsString()Specifies whether the control is a standard control or a custom control.-
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
-
arn
public final String arn()
The Amazon Resource Name (ARN) of the control.
- Returns:
- The Amazon Resource Name (ARN) of the control.
-
id
public final String id()
The unique identifier for the control.
- Returns:
- The unique identifier for the control.
-
type
public final ControlType type()
Specifies whether the control is a standard control or a custom control.
If the service returns an enum value that is not available in the current SDK version,
typewill returnControlType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- Specifies whether the control is a standard control or a custom control.
- See Also:
ControlType
-
typeAsString
public final String typeAsString()
Specifies whether the control is a standard control or a custom control.
If the service returns an enum value that is not available in the current SDK version,
typewill returnControlType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- Specifies whether the control is a standard control or a custom control.
- See Also:
ControlType
-
name
public final String name()
The name of the control.
- Returns:
- The name of the control.
-
description
public final String description()
The description of the control.
- Returns:
- The description of the control.
-
testingInformation
public final String testingInformation()
The steps that you should follow to determine if the control has been satisfied.
- Returns:
- The steps that you should follow to determine if the control has been satisfied.
-
actionPlanTitle
public final String actionPlanTitle()
The title of the action plan for remediating the control.
- Returns:
- The title of the action plan for remediating the control.
-
actionPlanInstructions
public final String actionPlanInstructions()
The recommended actions to carry out if the control isn't fulfilled.
- Returns:
- The recommended actions to carry out if the control isn't fulfilled.
-
controlSources
public final String controlSources()
The data source types that determine where Audit Manager collects evidence from for the control.
- Returns:
- The data source types that determine where Audit Manager collects evidence from for the control.
-
hasControlMappingSources
public final boolean hasControlMappingSources()
For responses, this returns true if the service returned a value for the ControlMappingSources property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
controlMappingSources
public final List<ControlMappingSource> controlMappingSources()
The data mapping sources for the control.
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
hasControlMappingSources()method.- Returns:
- The data mapping sources for the control.
-
createdAt
public final Instant createdAt()
The time when the control was created.
- Returns:
- The time when the control was created.
-
lastUpdatedAt
public final Instant lastUpdatedAt()
The time when the control was most recently updated.
- Returns:
- The time when the control was most recently updated.
-
createdBy
public final String createdBy()
The user or role that created the control.
- Returns:
- The user or role that created the control.
-
lastUpdatedBy
public final String lastUpdatedBy()
The user or role that most recently updated the control.
- Returns:
- The user or role that most recently updated the control.
-
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 theisEmpty()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()
The tags associated with the control.
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:
- The tags associated with the control.
-
state
public final ControlState state()
The state of the control. The
END_OF_SUPPORTstate is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control.If the service returns an enum value that is not available in the current SDK version,
statewill returnControlState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the control. The
END_OF_SUPPORTstate is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control. - See Also:
ControlState
-
stateAsString
public final String stateAsString()
The state of the control. The
END_OF_SUPPORTstate is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control.If the service returns an enum value that is not available in the current SDK version,
statewill returnControlState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The state of the control. The
END_OF_SUPPORTstate is applicable to standard controls only. This state indicates that the standard control can still be used to collect evidence, but Audit Manager is no longer updating or maintaining that control. - See Also:
ControlState
-
toBuilder
public Control.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Control.Builder,Control>
-
builder
public static Control.Builder builder()
-
serializableBuilderClass
public static Class<? extends Control.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-