Package software.amazon.awssdk.services.accessanalyzer.model

Class TrailProperties

java.lang.Object

software.amazon.awssdk.services.accessanalyzer.model.TrailProperties

All Implemented Interfaces:

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

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

Contains details about the CloudTrail trail being analyzed to generate a policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TrailProperties.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	allRegions()	Possible values are true or false.
static TrailProperties.Builder	builder()
String	cloudTrailArn()	Specifies the ARN of the trail.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRegions()	For responses, this returns true if the service returned a value for the Regions property.
List<String>	regions()	A list of regions to get CloudTrail data from and analyze to generate a policy.
List<SdkField<?>>	sdkFields()
static Class<? extends TrailProperties.Builder>	serializableBuilderClass()
TrailProperties.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

cloudTrailArn

public final String cloudTrailArn()

Specifies the ARN of the trail. The format of a trail ARN is arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.

Returns:

Specifies the ARN of the trail. The format of a trail ARN is arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail.

hasRegions

public final boolean hasRegions()

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

regions

public final List<String> regions()

A list of regions to get CloudTrail data from and analyze to generate a policy.

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

Returns:

A list of regions to get CloudTrail data from and analyze to generate a policy.

allRegions

public final Boolean allRegions()

Possible values are true or false. If set to true, IAM Access Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.

Returns:

Possible values are true or false. If set to true, IAM Access Analyzer retrieves CloudTrail data from all regions to analyze and generate a policy.

toBuilder

public TrailProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TrailProperties.Builder,TrailProperties>

builder

public static TrailProperties.Builder builder()

serializableBuilderClass

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