Struct aws_sdk_cloudtrail::model::advanced_field_selector::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for AdvancedFieldSelector

Implementations

impl Builder

pub fn field(self, input: impl Into<String>) -> Self

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: :s3::: /

  • arn: :s3::: / /

  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: :s3: : :accesspoint/

  • arn: :s3: : :accesspoint/ /object/

  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: :lambda: : :function:

  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: :dynamodb: : :table/

  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: :s3-outposts: : :

  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: :managedblockchain: : :nodes/

  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: :s3-object-lambda: : :accesspoint/

  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: :ec2: ::snapshot/

  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: :dynamodb: : :table/ /stream/

  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: :glue: : :table/ /

pub fn set_field(self, input: Option<String>) -> Self

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: :s3::: /

  • arn: :s3::: / /

  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: :s3: : :accesspoint/

  • arn: :s3: : :accesspoint/ /object/

  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: :lambda: : :function:

  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: :dynamodb: : :table/

  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: :s3-outposts: : :

  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: :managedblockchain: : :nodes/

  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: :s3-object-lambda: : :accesspoint/

  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: :ec2: ::snapshot/

  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: :dynamodb: : :table/ /stream/

  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: :glue: : :table/ /

pub fn equals(self, input: impl Into<String>) -> Self

Appends an item to equals.

To override the contents of this collection use set_equals.

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.

pub fn set_equals(self, input: Option<Vec<String>>) -> Self

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.

pub fn starts_with(self, input: impl Into<String>) -> Self

Appends an item to starts_with.

To override the contents of this collection use set_starts_with.

An operator that includes events that match the first few characters of the event record field specified as the value of Field.

pub fn set_starts_with(self, input: Option<Vec<String>>) -> Self

An operator that includes events that match the first few characters of the event record field specified as the value of Field.

pub fn ends_with(self, input: impl Into<String>) -> Self

Appends an item to ends_with.

To override the contents of this collection use set_ends_with.

An operator that includes events that match the last few characters of the event record field specified as the value of Field.

pub fn set_ends_with(self, input: Option<Vec<String>>) -> Self

An operator that includes events that match the last few characters of the event record field specified as the value of Field.

pub fn not_equals(self, input: impl Into<String>) -> Self

Appends an item to not_equals.

To override the contents of this collection use set_not_equals.

An operator that excludes events that match the exact value of the event record field specified as the value of Field.

pub fn set_not_equals(self, input: Option<Vec<String>>) -> Self

An operator that excludes events that match the exact value of the event record field specified as the value of Field.

pub fn not_starts_with(self, input: impl Into<String>) -> Self

Appends an item to not_starts_with.

To override the contents of this collection use set_not_starts_with.

An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

pub fn set_not_starts_with(self, input: Option<Vec<String>>) -> Self

An operator that excludes events that match the first few characters of the event record field specified as the value of Field.

pub fn not_ends_with(self, input: impl Into<String>) -> Self

Appends an item to not_ends_with.

To override the contents of this collection use set_not_ends_with.

An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

pub fn set_not_ends_with(self, input: Option<Vec<String>>) -> Self

An operator that excludes events that match the last few characters of the event record field specified as the value of Field.

pub fn build(self) -> AdvancedFieldSelector

Consumes the builder and constructs a AdvancedFieldSelector

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Builder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

fn eq(&self, other: &Builder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Builder) -> bool

This method tests for !=.

impl StructuralPartialEq for Builder