software.amazon.awssdk.services.cloudtrail.model

Class CreateTrailResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse

software.amazon.awssdk.services.cloudtrail.model.CreateTrailResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTrailResponse.Builder,CreateTrailResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateTrailResponse
extends CloudTrailResponse
implements ToCopyableBuilder<CreateTrailResponse.Builder,CreateTrailResponse>

Returns the objects or data listed below if successful. Otherwise, returns an error.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateTrailResponse.Builder

Method Summary

Modifier and Type	Method and Description
static CreateTrailResponse.Builder	builder()
String	cloudWatchLogsLogGroupArn() Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
String	cloudWatchLogsRoleArn() Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	includeGlobalServiceEvents() Specifies whether the trail is publishing events from global services such as IAM to the log files.
Boolean	isMultiRegionTrail() Specifies whether the trail exists in one region or in all regions.
Boolean	isOrganizationTrail() Specifies whether the trail is an organization trail.
String	kmsKeyId() Specifies the KMS key ID that encrypts the logs delivered by CloudTrail.
Boolean	logFileValidationEnabled() Specifies whether log file integrity validation is enabled.
String	name() Specifies the name of the trail.
String	s3BucketName() Specifies the name of the Amazon S3 bucket designated for publishing log files.
String	s3KeyPrefix() Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTrailResponse.Builder>	serializableBuilderClass()
String	snsTopicARN() Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered.
String	snsTopicName() This field is no longer in use.
CreateTrailResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	trailARN() Specifies the ARN of the trail that was created.

Methods inherited from class software.amazon.awssdk.services.cloudtrail.model.CloudTrailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

name

public String name()

Specifies the name of the trail.

Returns:

Specifies the name of the trail.

s3BucketName

public String s3BucketName()

Specifies the name of the Amazon S3 bucket designated for publishing log files.

Returns:

Specifies the name of the Amazon S3 bucket designated for publishing log files.

s3KeyPrefix

public String s3KeyPrefix()

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

Returns:

Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files.

snsTopicName

public String snsTopicName()

This field is no longer in use. Use SnsTopicARN.

Returns:

This field is no longer in use. Use SnsTopicARN.

snsTopicARN

public String snsTopicARN()

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-2:123456789012:MyTopic

Returns:

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:

arn:aws:sns:us-east-2:123456789012:MyTopic

includeGlobalServiceEvents

public Boolean includeGlobalServiceEvents()

Specifies whether the trail is publishing events from global services such as IAM to the log files.

Returns:

Specifies whether the trail is publishing events from global services such as IAM to the log files.

isMultiRegionTrail

public Boolean isMultiRegionTrail()

Specifies whether the trail exists in one region or in all regions.

Returns:

Specifies whether the trail exists in one region or in all regions.

trailARN

public String trailARN()

Specifies the ARN of the trail that was created. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

Returns:

Specifies the ARN of the trail that was created. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

logFileValidationEnabled

public Boolean logFileValidationEnabled()

Specifies whether log file integrity validation is enabled.

Returns:

Specifies whether log file integrity validation is enabled.

cloudWatchLogsLogGroupArn

public String cloudWatchLogsLogGroupArn()

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

Returns:

Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.

cloudWatchLogsRoleArn

public String cloudWatchLogsRoleArn()

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Returns:

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

kmsKeyId

public String kmsKeyId()

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

Returns:

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:

arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

isOrganizationTrail

public Boolean isOrganizationTrail()

Specifies whether the trail is an organization trail.

Returns:

Specifies whether the trail is an organization trail.

toBuilder

public CreateTrailResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTrailResponse.Builder,CreateTrailResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateTrailResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo