trail#

State module for managing Amazon Cloudtrail Trail resource.

async idem_aws.states.aws.cloudtrail.trail.present(hub, ctx, name: str, s3_bucket_name: str, resource_id: str = None, s3_key_prefix: str = None, sns_topic_name: str = None, include_global_service_events: bool = None, is_multi_region_trail: bool = None, enable_logfile_validation: bool = None, cloud_watch_logs_loggroup_arn: str = None, cloud_watch_logs_role_arn: str = None, kms_key_id: str = None, is_organization_trail: bool = None, tags: Dict[str, Any] = None, is_logging: bool = None, insight_selectors: List[InsightSelectors] = None, event_selectors: List[EventSelector] = None, advanced_event_selectors: List[AdvancedEventSelector] = None) → Dict[str, Any][source]#

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.

Parameters:

  • name (str) –

    An Idem name of the resource 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)

  • s3_bucket_name (str) – Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

  • resource_id (str, Optional) – Trail name to identify the resource

  • s3_key_prefix (str, Optional) – 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.

  • sns_topic_name (str, Optional) – Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

  • include_global_service_events (bool, Optional) – Specifies whether the trail is publishing events from global services such as IAM to the log files.

  • is_multi_region_trail (bool, Optional) – Specifies whether the trail is created in the current region or in all regions. The default is false, which creates a trail only in the region where you are signed in. As a best practice, consider creating trails that log events in all regions.

  • enable_logfile_validation (bool, Optional) – Specifies whether log file integrity validation is enabled. The default is false.

  • cloud_watch_logs_loggroup_arn (str, Optional) – Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn .

  • cloud_watch_logs_role_arn (str, Optional) – Specifies the role for the CloudWatch Logs endpoint to assume to write to a user’s log group.

  • kms_key_id (str, Optional) –

    Specifies the 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 KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

    Examples of multi-Region keys:

    • 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

  • is_organization_trail (bool, Optional) – Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in Organizations.

  • tags (dict or list, Optional) –

    Dict in the format of {tag-key: tag-value} or List of tags in the format of [{“Key”: tag-key, “Value”: tag-value}] to associate with the CloudTrail trail.

    • (Key): The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.

    • (Value, Optional): The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.

  • is_logging (bool, Optional) – Start and Stop the logging of CloudTrail

  • insight_selectors (list[dict[str, Any]]) –

    A JSON string that contains the insight types you want to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

    • InsightType (str, Optional): The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.

  • event_selectors (list[dict[str, Any]], Optional) –

    Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either EventSelectors or AdvancedEventSelectors in a PutEventSelectors request, but not both. If you apply EventSelectors to a trail, any existing AdvancedEventSelectors are overwritten. Defaults to None.

    • ReadWriteType (str, Optional): Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation. By default, the value is All.

    • IncludeManagementEvents (bool, Optional): Specify if you want your event selector to include management events for your trail. For more information, see Management Events in the CloudTrail User Guide. By default, the value is true. The first copy of management events is free. You are charged for additional copies of management events that you are logging on any subsequent trail in the same region. For more information about CloudTrail pricing, see CloudTrail Pricing.

    • DataResources (list[dict[str, Any]], Optional): CloudTrail supports data event logging for Amazon S3 objects, Lambda functions, and Amazon DynamoDB tables with basic event selectors. You can specify up to 250 resources for an individual event selector, but the total number of data resources cannot exceed 250 across all event selectors in a trail. This limit does not apply if you configure resource logging for all data events. For more information, see Data Events and Limits in CloudTrail in the CloudTrail User Guide.

      • Type (str, Optional): The resource type in which you want to log data events. You can specify the following basic event selector resource types:

        • AWS::S3::Object

        • AWS::Lambda::Function

        • AWS::DynamoDB::Table

        The following resource types are also availble through advanced event selectors. Basic event selector resource types are valid in advanced event selectors, but advanced event selector resource types are not valid in basic event selectors. For more information, see AdvancedFieldSelector$Field.

      • Values (list[str], Optional): An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects.

        • To log data events for all objects in all S3 buckets in your Amazon Web Services account, specify the prefix as arn:aws:s3:::. This also enables logging of data event activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a bucket that belongs to another Amazon Web Services account.

        • To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as arn:aws:s3:::bucket-1/. The trail logs data events for all objects in this S3 bucket.

        • To log data events for specific objects, specify the S3 bucket and object prefix such as arn:aws:s3:::bucket-1/example-images. The trail logs data events for objects in this S3 bucket that match the prefix.

        • To log data events for all Lambda functions in your Amazon Web Services account, specify the prefix as arn:aws:lambda. This also enables logging of Invoke activity performed by any user or role in your Amazon Web Services account, even if that activity is performed on a function that belongs to another Amazon Web Services account.

        • To log data events for a specific Lambda function, specify the function ARN. Lambda function ARNs are exact. For example, if you specify a function ARN arn:aws:lambda:us- west-2:111111111111:function:helloworld, data events will only be logged for arn:aws:lambda:us- west-2:111111111111:function:helloworld. They will not be logged for arn:aws:lambda:us- west-2:111111111111:function:helloworld2.

        • To log data events for all DynamoDB tables in your Amazon Web Services account, specify the prefix as arn:aws:dynamodb.

    • ExcludeManagementEventSources (list[str], Optional): An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out Key Management Service or Amazon RDS Data API events by containing kms.amazonaws.com or rdsdata.amazonaws.com. By default, ExcludeManagementEventSources is empty, and KMS and Amazon RDS Data API events are logged to your trail. You can exclude management event sources only in regions that support the event source.

  • advanced_event_selectors (list[dict[str, Any]], Optional) –

    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 for trails in the CloudTrail User Guide. Defaults to None.

    • Name (str, Optional): An optional, descriptive name for an advanced event selector, such as “Log data events for only two S3 buckets”.

    • FieldSelectors (list[dict[str, Any]]): Contains all selector statements in an advanced event selector.

      • Field (str): A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN.

        • readOnly - Optional. Can be set to Equals a value of true or false. If you do not add this field, CloudTrail logs both both read and write events. A value of true logs only read events. A value of false logs only write events.

        • eventSource - For filtering management events only. This can be set only to NotEquals kms.amazonaws.com.

        • eventName - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as PutBucket or GetSnapshotBlock. You can have multiple values for this field, separated by commas.

        • eventCategory - This is required. It must be set to Equals, and the value must be Management or Data.

        • resources.type - This field is required. resources.type can only use the Equals operator, and the value can be one of the following:

          • AWS::S3::Object

          • AWS::Lambda::Function

          • AWS::DynamoDB::Table

          • AWS::S3Outposts::Object

          • AWS::ManagedBlockchain::Node

          • AWS::S3ObjectLambda::AccessPoint

          • AWS::EC2::Snapshot

          • AWS::S3::AccessPoint

          • AWS::DynamoDB::Stream

          • AWS::Glue::Table

          You can have only one resources.type field per selector. To log data events on more than one resource type, add another selector.

          • resources.ARN - You can use any operator with resources.ARN, but if you use Equals or NotEquals, the value must exactly match the ARN of a valid resource of the type you’ve specified in the template as the value of resources.type. For example, if resources.type equals AWS::S3::Object, the ARN must be in one of the following formats. To log all data events for all objects in a specific S3 bucket, use the StartsWith operator, and include only the bucket ARN as the matching value. The trailing slash is intentional; do not exclude it. Replace the text between less than and greater than symbols (<>) with resource-specific information.

            • arn:<partition>:s3:::<bucket_name>/

            • arn:<partition>:s3:::<bucket_name>/<object_path>/

            When resources.type equals AWS::S3::AccessPoint, and the operator is set to Equals or NotEquals, the ARN must be in one of the following formats. To log events on all objects in an S3 access point, we recommend that you use only the access point ARN, don’t include the object path, and use the StartsWith or NotStartsWith operators.

            • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>

            • arn:<partition>:s3:<region>:<account_ID>:accesspoint/<access_point_name>/object/<object_path>

            When resources.type equals AWS::Lambda::Function, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:lambda:<region>:<account_ID>:function:<function_name>

            When resources.type equals AWS::DynamoDB::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>

            When resources.type equals AWS::S3Outposts::Object, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>

            When resources.type equals AWS::ManagedBlockchain::Node, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>

            When resources.type equals AWS::S3ObjectLambda::AccessPoint, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>

            When resources.type equals AWS::EC2::Snapshot, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>

            When resources.type equals AWS::DynamoDB::Stream, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:dynamodb:<region>:<account_ID>:table/<table_name>/stream/<date_time>

            When resources.type equals AWS::Glue::Table, and the operator is set to Equals or NotEquals, the ARN must be in the following format:

            • arn:<partition>:glue:<region>:<account_ID>:table/<database_name>/<table_name>

        • Equals (list[str], Optional): An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields.

        • StartsWith (list[str], Optional): An operator that includes events that match the first few characters of the event record field specified as the value of Field.

        • EndsWith (list[str], Optional): An operator that includes events that match the last few characters of the event record field specified as the value of Field.

        • NotEquals (list[str], Optional): An operator that excludes events that match the exact value of the event record field specified as the value of Field.

        • NotStartsWith (list[str], Optional): An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

        • NotEndsWith (list[str], Optional): An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

Request Syntax:
[trail_name]:
  aws.cloudtrail.trail.present:
  - resource_id: 'string'
  - s3_bucket_name: 'string'
  - s3_key_prefix: 'string'
  - sns_topic_name: 'string'
  - include_global_service_events: boolean
  - is_multi_region_trail: boolean
  - enable_log_file_validation: boolean
  - cloud_watch_logs_loggroup_arn: 'string'
  - cloud_watch_logs_role_arn: 'string'
  - kms_key_id: 'string'
  - is_organization_trail: boolean
  - tags:
     - Key: 'string'
      Value: 'string'

Examples

test-trail:
  aws.cloudtrail.trail.present:
  - name: test-trail
  - resource_id: test-trail
  - enable_logfile_validation: false
  - s3_bucket_name: test-bucket1
  - s3_key_prefix: test-bucket
  - sns_topic_name: arn:aws:sns:us-east-2:123456789012:MyTopic
  - include_global_service_events: true
  - is_multi_region_trail: true
  - cloud_watch_logs_loggroup_arn: arn:aws:logs:us-east-2:123456789012:log-group:aws-cloudtrail-logs-123456789012:*
  - cloud_watch_logs_role_arn: arn:aws:iam::123456789012:role/service-role/cloudtrailrole
  - kms_key_id: arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
  - is_organization_trail: false
  - trail_arn: arn:aws:cloudtrail:us-east-2:123456789012:trail/test-trail
  - tags:
    - Key: trail
      Value: test-trail
  - is_logging: true
  - event_selectors: null
  - advanced_event_selectors:
    - FieldSelectors:
      - Field: eventCategory
        Equals:
         - Data
      - Field: resources.type
        Equals:
         - AWS::S3::Object
    - Name: Management events selector
      FieldSelectors:
      - Field: eventCategory
        Equals:
        - Management
  - insight_selectors:
    - InsightType: ApiCallRateInsight
    - InsightType: ApiErrorRateInsight
async idem_aws.states.aws.cloudtrail.trail.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Deletes a trail.

This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

Parameters:

  • name (str) – An Idem name of the resource.

  • resource_id (str, Optional) – Trail name to identify the resource. Idem automatically considers this resource being absent if this field is not specified.

Returns:

Dict[str, Any]

Examples

resource_is_absent:
  aws.cloudtrail.trail.absent:
    - name: value
    - resource_id: value
async idem_aws.states.aws.cloudtrail.trail.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Lists trails that are in the current account including Logging Status, Event Selectors and Insight Selectors as well.

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Returns:

Dict[str, Any]

Examples

$ idem describe aws.cloudtrail.trail