Package software.amazon.awscdk.services.cloudtrail

Class CfnTrailProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cloudtrail.CfnTrailProps.Jsii$Proxy
All Implemented Interfaces:
CfnTrailProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnTrailProps
@Stability(Stable) @Internal public static final class CfnTrailProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnTrailProps
An implementation for CfnTrailProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudtrail.CfnTrailProps

    CfnTrailProps.Builder, CfnTrailProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnTrailProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnTrailProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final Object
    getAdvancedEventSelectors()
    Specifies the settings for advanced event selectors.
    final String
    getCloudWatchLogsLogGroupArn()
    Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered.
    final String
    getCloudWatchLogsRoleArn()
    Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
    final Object
    getEnableLogFileValidation()
    Specifies whether log file validation is enabled.
    final Object
    getEventSelectors()
    Use event selectors to further specify the management and data event settings for your trail.
    final Object
    getIncludeGlobalServiceEvents()
    Specifies whether the trail is publishing events from global services such as IAM to the log files.
    final Object
    getInsightSelectors()
    A JSON string that contains the insight types you want to log on a trail.
    final Object
    getIsLogging()
    Whether the CloudTrail trail is currently logging AWS API calls.
    final Object
    getIsMultiRegionTrail()
    Specifies whether the trail applies only to the current Region or to all Regions.
    final Object
    getIsOrganizationTrail()
    Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .
    final String
    getKmsKeyId()
    Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail.
    final String
    getS3BucketName()
    Specifies the name of the Amazon S3 bucket designated for publishing log files.
    final String
    getS3KeyPrefix()
    Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
    final String
    getSnsTopicName()
    Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
    final List<CfnTag>
    getTags()
    A custom set of tags (key-value pairs) for this trail.
    final String
    getTrailName()
    Specifies the name of the trail.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnTrailProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnTrailProps.Builder.

  • Method Details

    • getIsLogging

      public final Object getIsLogging()
      Description copied from interface: CfnTrailProps
      Whether the CloudTrail trail is currently logging AWS API calls.
      Specified by:
      getIsLogging in interface CfnTrailProps

    • getS3BucketName

      public final String getS3BucketName()
      Description copied from interface: CfnTrailProps
      Specifies the name of the Amazon S3 bucket designated for publishing log files.

      See Amazon S3 Bucket Naming Requirements .

      Specified by:
      getS3BucketName in interface CfnTrailProps

    • getAdvancedEventSelectors

      public final Object getAdvancedEventSelectors()
      Description copied from interface: CfnTrailProps
      Specifies the settings for advanced event selectors.

      You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors , but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events in the AWS CloudTrail User Guide .

      Specified by:
      getAdvancedEventSelectors in interface CfnTrailProps

    • getCloudWatchLogsLogGroupArn

      public final String getCloudWatchLogsLogGroupArn()
      Description copied from interface: CfnTrailProps
      Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs are delivered.

      You must use a log group that exists in your account.

      Not required unless you specify CloudWatchLogsRoleArn .

      Specified by:
      getCloudWatchLogsLogGroupArn in interface CfnTrailProps

    • getCloudWatchLogsRoleArn

      public final String getCloudWatchLogsRoleArn()
      Description copied from interface: CfnTrailProps
      Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

      You must use a role that exists in your account.

      Specified by:
      getCloudWatchLogsRoleArn in interface CfnTrailProps

    • getEnableLogFileValidation

      public final Object getEnableLogFileValidation()
      Description copied from interface: CfnTrailProps
      Specifies whether log file validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

      Specified by:
      getEnableLogFileValidation in interface CfnTrailProps

    • getEventSelectors

      public final Object getEventSelectors()
      Description copied from interface: CfnTrailProps
      Use event selectors to further specify the management and data event settings for your trail.

      By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

      You can configure up to five event selectors for a trail.

      For more information about how to configure event selectors, see Examples and Configuring event selectors in the AWS CloudTrail User Guide .

      Specified by:
      getEventSelectors in interface CfnTrailProps

    • getIncludeGlobalServiceEvents

      public final Object getIncludeGlobalServiceEvents()
      Description copied from interface: CfnTrailProps
      Specifies whether the trail is publishing events from global services such as IAM to the log files.
      Specified by:
      getIncludeGlobalServiceEvents in interface CfnTrailProps

    • getInsightSelectors

      public final Object getInsightSelectors()
      Description copied from interface: CfnTrailProps
      A JSON string that contains the insight types you want to log on a trail.

      ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.

      The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.

      The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.

      Specified by:
      getInsightSelectors in interface CfnTrailProps

    • getIsMultiRegionTrail

      public final Object getIsMultiRegionTrail()
      Description copied from interface: CfnTrailProps
      Specifies whether the trail applies only to the current Region or to all Regions.

      The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions.

      Specified by:
      getIsMultiRegionTrail in interface CfnTrailProps

    • getIsOrganizationTrail

      public final Object getIsOrganizationTrail()
      Description copied from interface: CfnTrailProps
      Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .

      The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management account or delegated administrator account for an organization in AWS Organizations . If the trail is not an organization trail and this is set to true , the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false , the trail will remain in the current AWS account but be deleted from all member accounts in the organization.

      Specified by:
      getIsOrganizationTrail in interface CfnTrailProps

    • getKmsKeyId

      public final String getKmsKeyId()
      Description copied from interface: CfnTrailProps
      Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail.

      The value can be an alias name prefixed by "alias/", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

      CloudTrail also supports AWS KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide .

      Examples:

      • alias/MyAliasName
      • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName
      • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
      • 12345678-1234-1234-1234-123456789012
      Specified by:
      getKmsKeyId in interface CfnTrailProps

    • getS3KeyPrefix

      public final String getS3KeyPrefix()
      Description copied from interface: CfnTrailProps
      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 . The maximum length is 200 characters.

      Specified by:
      getS3KeyPrefix in interface CfnTrailProps

    • getSnsTopicName

      public final String getSnsTopicName()
      Description copied from interface: CfnTrailProps
      Specifies the name of the Amazon SNS topic defined for notification of log file delivery.

      The maximum length is 256 characters.

      Specified by:
      getSnsTopicName in interface CfnTrailProps

    • getTags

      public final List<CfnTag> getTags()
      Description copied from interface: CfnTrailProps
      A custom set of tags (key-value pairs) for this trail.
      Specified by:
      getTags in interface CfnTrailProps

    • getTrailName

      public final String getTrailName()
      Description copied from interface: CfnTrailProps
      Specifies the name of the trail. The name must meet the following requirements:.

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)
      • Start with a letter or number, and end with a letter or number
      • Be between 3 and 128 characters
      • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.
      • Not be in IP address format (for example, 192.168.5.4)
      Specified by:
      getTrailName in interface CfnTrailProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object