Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Synopsis
- defaultService :: Service
- _InvalidTimeRangeException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientS3BucketPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _MaximumNumberOfTrailsExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientDependencyServiceAccessPermissionException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidEventCategoryException :: AsError a => Getting (First ServiceError) a ServiceError
- _KmsKeyDisabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientEncryptionPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientSnsTopicPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCloudWatchLogsRoleArnException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudTrailAccessNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _TagsLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudTrailARNInvalidException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidLookupAttributesException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTrailNameException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSnsTopicNameException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceTypeNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudWatchLogsDeliveryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _OrganizationsNotInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- _KmsKeyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TrailNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsightNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotOrganizationMasterAccountException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidEventSelectorsException :: AsError a => Getting (First ServiceError) a ServiceError
- _TrailNotProvidedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidS3BucketNameException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidCloudWatchLogsLogGroupArnException :: AsError a => Getting (First ServiceError) a ServiceError
- _KmsException :: AsError a => Getting (First ServiceError) a ServiceError
- _CloudTrailInvalidClientTokenIdException :: AsError a => Getting (First ServiceError) a ServiceError
- _S3BucketDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTagParameterException :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTokenException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidMaxResultsException :: AsError a => Getting (First ServiceError) a ServiceError
- _TrailAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _OrganizationNotInAllFeaturesModeException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInsightSelectorsException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidS3PrefixException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidKmsKeyIdException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidHomeRegionException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype EventCategory where
- EventCategory' { }
- pattern EventCategory_Insight :: EventCategory
- newtype InsightType where
- InsightType' { }
- pattern InsightType_ApiCallRateInsight :: InsightType
- newtype LookupAttributeKey where
- LookupAttributeKey' { }
- pattern LookupAttributeKey_AccessKeyId :: LookupAttributeKey
- pattern LookupAttributeKey_EventId :: LookupAttributeKey
- pattern LookupAttributeKey_EventName :: LookupAttributeKey
- pattern LookupAttributeKey_EventSource :: LookupAttributeKey
- pattern LookupAttributeKey_ReadOnly :: LookupAttributeKey
- pattern LookupAttributeKey_ResourceName :: LookupAttributeKey
- pattern LookupAttributeKey_ResourceType :: LookupAttributeKey
- pattern LookupAttributeKey_Username :: LookupAttributeKey
- newtype ReadWriteType where
- ReadWriteType' { }
- pattern ReadWriteType_All :: ReadWriteType
- pattern ReadWriteType_ReadOnly :: ReadWriteType
- pattern ReadWriteType_WriteOnly :: ReadWriteType
- data AdvancedEventSelector = AdvancedEventSelector' {}
- newAdvancedEventSelector :: NonEmpty AdvancedFieldSelector -> AdvancedEventSelector
- advancedEventSelector_name :: Lens' AdvancedEventSelector (Maybe Text)
- advancedEventSelector_fieldSelectors :: Lens' AdvancedEventSelector (NonEmpty AdvancedFieldSelector)
- data AdvancedFieldSelector = AdvancedFieldSelector' {}
- newAdvancedFieldSelector :: Text -> AdvancedFieldSelector
- advancedFieldSelector_endsWith :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text))
- advancedFieldSelector_notStartsWith :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text))
- advancedFieldSelector_equals :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text))
- advancedFieldSelector_notEquals :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text))
- advancedFieldSelector_notEndsWith :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text))
- advancedFieldSelector_startsWith :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text))
- advancedFieldSelector_field :: Lens' AdvancedFieldSelector Text
- data DataResource = DataResource' {}
- newDataResource :: DataResource
- dataResource_values :: Lens' DataResource (Maybe [Text])
- dataResource_type :: Lens' DataResource (Maybe Text)
- data Event = Event' {}
- newEvent :: Event
- event_username :: Lens' Event (Maybe Text)
- event_resources :: Lens' Event (Maybe [Resource])
- event_eventTime :: Lens' Event (Maybe UTCTime)
- event_cloudTrailEvent :: Lens' Event (Maybe Text)
- event_eventName :: Lens' Event (Maybe Text)
- event_readOnly :: Lens' Event (Maybe Text)
- event_accessKeyId :: Lens' Event (Maybe Text)
- event_eventSource :: Lens' Event (Maybe Text)
- event_eventId :: Lens' Event (Maybe Text)
- data EventSelector = EventSelector' {}
- newEventSelector :: EventSelector
- eventSelector_dataResources :: Lens' EventSelector (Maybe [DataResource])
- eventSelector_readWriteType :: Lens' EventSelector (Maybe ReadWriteType)
- eventSelector_excludeManagementEventSources :: Lens' EventSelector (Maybe [Text])
- eventSelector_includeManagementEvents :: Lens' EventSelector (Maybe Bool)
- data InsightSelector = InsightSelector' {}
- newInsightSelector :: InsightSelector
- insightSelector_insightType :: Lens' InsightSelector (Maybe InsightType)
- data LookupAttribute = LookupAttribute' {}
- newLookupAttribute :: LookupAttributeKey -> Text -> LookupAttribute
- lookupAttribute_attributeKey :: Lens' LookupAttribute LookupAttributeKey
- lookupAttribute_attributeValue :: Lens' LookupAttribute Text
- data PublicKey = PublicKey' {}
- newPublicKey :: PublicKey
- publicKey_fingerprint :: Lens' PublicKey (Maybe Text)
- publicKey_validityEndTime :: Lens' PublicKey (Maybe UTCTime)
- publicKey_value :: Lens' PublicKey (Maybe ByteString)
- publicKey_validityStartTime :: Lens' PublicKey (Maybe UTCTime)
- data Resource = Resource' {}
- newResource :: Resource
- resource_resourceType :: Lens' Resource (Maybe Text)
- resource_resourceName :: Lens' Resource (Maybe Text)
- data ResourceTag = ResourceTag' {}
- newResourceTag :: ResourceTag
- resourceTag_resourceId :: Lens' ResourceTag (Maybe Text)
- resourceTag_tagsList :: Lens' ResourceTag (Maybe [Tag])
- data Tag = Tag' {}
- newTag :: Text -> Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag Text
- data Trail = Trail' {
- logFileValidationEnabled :: Maybe Bool
- trailARN :: Maybe Text
- s3KeyPrefix :: Maybe Text
- hasInsightSelectors :: Maybe Bool
- snsTopicARN :: Maybe Text
- snsTopicName :: Maybe Text
- cloudWatchLogsLogGroupArn :: Maybe Text
- kmsKeyId :: Maybe Text
- homeRegion :: Maybe Text
- name :: Maybe Text
- includeGlobalServiceEvents :: Maybe Bool
- hasCustomEventSelectors :: Maybe Bool
- isOrganizationTrail :: Maybe Bool
- cloudWatchLogsRoleArn :: Maybe Text
- s3BucketName :: Maybe Text
- isMultiRegionTrail :: Maybe Bool
- newTrail :: Trail
- trail_logFileValidationEnabled :: Lens' Trail (Maybe Bool)
- trail_trailARN :: Lens' Trail (Maybe Text)
- trail_s3KeyPrefix :: Lens' Trail (Maybe Text)
- trail_hasInsightSelectors :: Lens' Trail (Maybe Bool)
- trail_snsTopicARN :: Lens' Trail (Maybe Text)
- trail_snsTopicName :: Lens' Trail (Maybe Text)
- trail_cloudWatchLogsLogGroupArn :: Lens' Trail (Maybe Text)
- trail_kmsKeyId :: Lens' Trail (Maybe Text)
- trail_homeRegion :: Lens' Trail (Maybe Text)
- trail_name :: Lens' Trail (Maybe Text)
- trail_includeGlobalServiceEvents :: Lens' Trail (Maybe Bool)
- trail_hasCustomEventSelectors :: Lens' Trail (Maybe Bool)
- trail_isOrganizationTrail :: Lens' Trail (Maybe Bool)
- trail_cloudWatchLogsRoleArn :: Lens' Trail (Maybe Text)
- trail_s3BucketName :: Lens' Trail (Maybe Text)
- trail_isMultiRegionTrail :: Lens' Trail (Maybe Bool)
- data TrailInfo = TrailInfo' {}
- newTrailInfo :: TrailInfo
- trailInfo_trailARN :: Lens' TrailInfo (Maybe Text)
- trailInfo_homeRegion :: Lens' TrailInfo (Maybe Text)
- trailInfo_name :: Lens' TrailInfo (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2013-11-01
of the Amazon CloudTrail SDK configuration.
Errors
_InvalidTimeRangeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Occurs if the timestamp values are not valid. Either the start time occurs after the end time, or the time range is outside the range of possible values.
_InsufficientS3BucketPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the policy on the S3 bucket is not sufficient.
_MaximumNumberOfTrailsExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the maximum number of trails is reached.
_InsufficientDependencyServiceAccessPermissionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the IAM user or role that is used to create the organization trail is lacking one or more required permissions for creating an organization trail in a required service. For more information, see Prepare For Creating a Trail For Your Organization.
_UnsupportedOperationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the requested operation is not supported.
_InvalidEventCategoryException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Occurs if an event category that is not valid is specified as a value of
EventCategory
.
_KmsKeyDisabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is no longer in use.
_InsufficientEncryptionPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.
_InsufficientSnsTopicPolicyException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the policy on the Amazon SNS topic is not sufficient.
_InvalidCloudWatchLogsRoleArnException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the provided role is not valid.
_CloudTrailAccessNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when trusted access has not been enabled between CloudTrail and Organizations. For more information, see Enabling Trusted Access with Other Amazon Web Services Services and Prepare For Creating a Trail For Your Organization.
_TagsLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.
_CloudTrailARNInvalidException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when an operation is called with a trail ARN that is not valid. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
_InvalidLookupAttributesException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Occurs when a lookup attribute is specified that is not valid.
_InvalidTrailNameException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the provided trail name is not valid. Trail names 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
andmy--namespace
are not valid. - Not be in IP address format (for example, 192.168.5.4)
_InvalidSnsTopicNameException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the provided SNS topic name is not valid.
_ResourceTypeNotSupportedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the specified resource type is not supported by CloudTrail.
_CloudWatchLogsDeliveryUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Cannot set a CloudWatch Logs delivery for this region.
_OrganizationsNotInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the request is made from an Amazon Web Services account that is not a member of an organization. To make this request, sign in using the credentials of an account that belongs to an organization.
_KmsKeyNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the KMS key does not exist, when the S3 bucket and the KMS key are not in the same region, or when the KMS key associated with the Amazon SNS topic either does not exist or is not in the same region.
_TrailNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the trail with the given name is not found.
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a trail before CloudTrail has time to fully load the trail. If this exception occurs, wait a few minutes, and then try the operation again.
_InsightNotEnabledException :: AsError a => Getting (First ServiceError) a ServiceError Source #
If you run GetInsightSelectors
on a trail that does not have Insights
events enabled, the operation throws the exception
InsightNotEnabledException
.
_NotOrganizationMasterAccountException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the Amazon Web Services account making the request to create or update an organization trail is not the management account for an organization in Organizations. For more information, see Prepare For Creating a Trail For Your Organization.
_InvalidEventSelectorsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the PutEventSelectors
operation is
called with a number of event selectors, advanced event selectors, or
data resources that is not valid. The combination of event selectors or
advanced event selectors and data resources is not valid. A trail can
have up to 5 event selectors. If a trail uses advanced event selectors,
a maximum of 500 total values for all conditions in all advanced event
selectors is allowed. A trail is limited to 250 data resources. These
data resources can be distributed across event selectors, but the
overall total cannot exceed 250.
You can:
- Specify a valid number of event selectors (1 to 5) for a trail.
- Specify a valid number of data resources (1 to 250) for an event selector. The limit of number of resources on an individual event selector is configurable up to 250. However, this upper limit is allowed only if the total number of data resources does not exceed 250 across all event selectors for a trail.
- Specify up to 500 values for all conditions in all advanced event selectors for a trail.
- Specify a valid value for a parameter. For example, specifying the
ReadWriteType
parameter with a value ofread-only
is not valid.
_TrailNotProvidedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is no longer in use.
_InvalidS3BucketNameException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the provided S3 bucket name is not valid.
_InvalidCloudWatchLogsLogGroupArnException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the provided CloudWatch Logs log group is not valid.
_KmsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.
_CloudTrailInvalidClientTokenIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when a call results in the
InvalidClientTokenId
error code. This can occur when you are creating
or updating a trail to send notifications to an Amazon SNS topic that is
in a suspended Amazon Web Services account.
_S3BucketDoesNotExistException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the specified S3 bucket does not exist.
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
A token that is not valid, or a token that was previously used in a request with different parameters. This exception is thrown if the token is not valid.
_InvalidTagParameterException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the specified tag key or values are not valid. It can also occur if there are duplicate tags or too many tags on the resource.
_OperationNotPermittedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the requested operation is not permitted.
_InvalidTokenException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Reserved for future use.
_InvalidMaxResultsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown if the limit specified is not valid.
_TrailAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the specified trail already exists.
_OrganizationNotInAllFeaturesModeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when Organizations is not configured to support all features. All features must be enabled in Organizations to support creating an organization trail. For more information, see Prepare For Creating a Trail For Your Organization.
_InvalidInsightSelectorsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The formatting or syntax of the InsightSelectors
JSON statement in
your PutInsightSelectors
or GetInsightSelectors
request is not
valid, or the specified insight type in the InsightSelectors
statement
is not a valid insight type.
_InvalidS3PrefixException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the provided S3 prefix is not valid.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the specified resource is not found.
_InvalidParameterCombinationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the combination of parameters provided is not valid.
_InvalidKmsKeyIdException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when the KMS key ARN is not valid.
_InvalidHomeRegionException :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.
EventCategory
newtype EventCategory Source #
pattern EventCategory_Insight :: EventCategory |
Instances
InsightType
newtype InsightType Source #
pattern InsightType_ApiCallRateInsight :: InsightType |
Instances
LookupAttributeKey
newtype LookupAttributeKey Source #
pattern LookupAttributeKey_AccessKeyId :: LookupAttributeKey | |
pattern LookupAttributeKey_EventId :: LookupAttributeKey | |
pattern LookupAttributeKey_EventName :: LookupAttributeKey | |
pattern LookupAttributeKey_EventSource :: LookupAttributeKey | |
pattern LookupAttributeKey_ReadOnly :: LookupAttributeKey | |
pattern LookupAttributeKey_ResourceName :: LookupAttributeKey | |
pattern LookupAttributeKey_ResourceType :: LookupAttributeKey | |
pattern LookupAttributeKey_Username :: LookupAttributeKey |
Instances
ReadWriteType
newtype ReadWriteType Source #
pattern ReadWriteType_All :: ReadWriteType | |
pattern ReadWriteType_ReadOnly :: ReadWriteType | |
pattern ReadWriteType_WriteOnly :: ReadWriteType |
Instances
AdvancedEventSelector
data AdvancedEventSelector Source #
Advanced event selectors let you create fine-grained selectors for the following CloudTrail event record fields. They help you control costs by logging only those events that are important to you. For more information about advanced event selectors, see Logging data events for trails in the CloudTrail User Guide.
readOnly
eventSource
eventName
eventCategory
resources.type
resources.ARN
You cannot apply both event selectors and advanced event selectors to a trail.
See: newAdvancedEventSelector
smart constructor.
AdvancedEventSelector' | |
|
Instances
newAdvancedEventSelector Source #
Create a value of AdvancedEventSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:AdvancedEventSelector'
, advancedEventSelector_name
- An optional, descriptive name for an advanced event selector, such as
"Log data events for only two S3 buckets".
$sel:fieldSelectors:AdvancedEventSelector'
, advancedEventSelector_fieldSelectors
- Contains all selector statements in an advanced event selector.
advancedEventSelector_name :: Lens' AdvancedEventSelector (Maybe Text) Source #
An optional, descriptive name for an advanced event selector, such as "Log data events for only two S3 buckets".
advancedEventSelector_fieldSelectors :: Lens' AdvancedEventSelector (NonEmpty AdvancedFieldSelector) Source #
Contains all selector statements in an advanced event selector.
AdvancedFieldSelector
data AdvancedFieldSelector Source #
A single selector statement in an advanced event selector.
See: newAdvancedFieldSelector
smart constructor.
AdvancedFieldSelector' | |
|
Instances
newAdvancedFieldSelector Source #
Create a value of AdvancedFieldSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endsWith:AdvancedFieldSelector'
, advancedFieldSelector_endsWith
- An operator that includes events that match the last few characters of
the event record field specified as the value of Field
.
$sel:notStartsWith:AdvancedFieldSelector'
, advancedFieldSelector_notStartsWith
- An operator that excludes events that match the first few characters of
the event record field specified as the value of Field
.
$sel:equals:AdvancedFieldSelector'
, advancedFieldSelector_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.
$sel:notEquals:AdvancedFieldSelector'
, advancedFieldSelector_notEquals
- An operator that excludes events that match the exact value of the event
record field specified as the value of Field
.
$sel:notEndsWith:AdvancedFieldSelector'
, advancedFieldSelector_notEndsWith
- An operator that excludes events that match the last few characters of
the event record field specified as the value of Field
.
$sel:startsWith:AdvancedFieldSelector'
, advancedFieldSelector_startsWith
- An operator that includes events that match the first few characters of
the event record field specified as the value of Field
.
$sel:field:AdvancedFieldSelector'
, advancedFieldSelector_field
- 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 toEquals
a value oftrue
orfalse
. A value offalse
logs bothread
andwrite
events.eventSource
- For filtering management events only. This can be set only toNotEquals
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 asPutBucket
orGetSnapshotBlock
. You can have multiple values for this field, separated by commas.eventCategory
- This is required. It must be set toEquals
, and the value must beManagement
orData
.resources.type
- This field is required.resources.type
can only use theEquals
operator, and the value can be one of the following:AWS::S3::Object
,AWS::S3::AccessPoint
,AWS::Lambda::Function
,AWS::DynamoDB::Table
,AWS::S3Outposts::Object
,AWS::ManagedBlockchain::Node
,AWS::S3ObjectLambda::AccessPoint
, orAWS::EC2::Snapshot
. You can have only oneresources.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 useEquals
orNotEquals
, 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 equalsAWS::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 theStartsWith
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
equalsAWS::S3::AccessPoint
, and the operator is set toEquals
orNotEquals
, 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 theStartsWith
orNotStartsWith
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 toEquals
orNotEquals
, 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 toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:dynamodb:<region>:<account_ID>:table:<table_name>
When
resources.type
equalsAWS::S3Outposts::Object
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When
resources.type
equalsAWS::ManagedBlockchain::Node
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When
resources.type
equalsAWS::S3ObjectLambda::AccessPoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When
resources.type
equalsAWS::EC2::Snapshot
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
advancedFieldSelector_endsWith :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text)) Source #
An operator that includes events that match the last few characters of
the event record field specified as the value of Field
.
advancedFieldSelector_notStartsWith :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text)) Source #
An operator that excludes events that match the first few characters of
the event record field specified as the value of Field
.
advancedFieldSelector_equals :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text)) Source #
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.
advancedFieldSelector_notEquals :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text)) Source #
An operator that excludes events that match the exact value of the event
record field specified as the value of Field
.
advancedFieldSelector_notEndsWith :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text)) Source #
An operator that excludes events that match the last few characters of
the event record field specified as the value of Field
.
advancedFieldSelector_startsWith :: Lens' AdvancedFieldSelector (Maybe (NonEmpty Text)) Source #
An operator that includes events that match the first few characters of
the event record field specified as the value of Field
.
advancedFieldSelector_field :: Lens' AdvancedFieldSelector Text Source #
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 toEquals
a value oftrue
orfalse
. A value offalse
logs bothread
andwrite
events.eventSource
- For filtering management events only. This can be set only toNotEquals
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 asPutBucket
orGetSnapshotBlock
. You can have multiple values for this field, separated by commas.eventCategory
- This is required. It must be set toEquals
, and the value must beManagement
orData
.resources.type
- This field is required.resources.type
can only use theEquals
operator, and the value can be one of the following:AWS::S3::Object
,AWS::S3::AccessPoint
,AWS::Lambda::Function
,AWS::DynamoDB::Table
,AWS::S3Outposts::Object
,AWS::ManagedBlockchain::Node
,AWS::S3ObjectLambda::AccessPoint
, orAWS::EC2::Snapshot
. You can have only oneresources.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 useEquals
orNotEquals
, 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 equalsAWS::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 theStartsWith
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
equalsAWS::S3::AccessPoint
, and the operator is set toEquals
orNotEquals
, 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 theStartsWith
orNotStartsWith
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 toEquals
orNotEquals
, 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 toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:dynamodb:<region>:<account_ID>:table:<table_name>
When
resources.type
equalsAWS::S3Outposts::Object
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-outposts:<region>:<account_ID>:<object_path>
When
resources.type
equalsAWS::ManagedBlockchain::Node
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:managedblockchain:<region>:<account_ID>:nodes/<node_ID>
When
resources.type
equalsAWS::S3ObjectLambda::AccessPoint
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:s3-object-lambda:<region>:<account_ID>:accesspoint/<access_point_name>
When
resources.type
equalsAWS::EC2::Snapshot
, and the operator is set toEquals
orNotEquals
, the ARN must be in the following format:arn:<partition>:ec2:<region>::snapshot/<snapshot_ID>
DataResource
data DataResource Source #
The Amazon S3 buckets, Lambda functions, or Amazon DynamoDB tables that you specify in your event selectors for your trail to log data events. Data events provide information about the resource operations performed on or within a resource itself. These are also known as data plane operations. You can specify up to 250 data resources for a trail.
The total number of allowed data resources is 250. This number can be distributed between 1 and 5 event selectors, but the total cannot exceed 250 across all selectors.
If you are using advanced event selectors, the maximum total number of values for all conditions, across all advanced event selectors for the trail, is 500.
The following example demonstrates how logging works when you configure
logging of all data events for an S3 bucket named bucket-1
. In this
example, the CloudTrail user specified an empty prefix, and the option
to log both Read
and Write
data events.
- A user uploads an image file to
bucket-1
. - The
PutObject
API operation is an Amazon S3 object-level API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified an S3 bucket with an empty prefix, events that occur on any object in that bucket are logged. The trail processes and logs the event. - A user uploads an object to an Amazon S3 bucket named
arn:aws:s3:::bucket-2
. - The
PutObject
API operation occurred for an object in an S3 bucket that the CloudTrail user didn't specify for the trail. The trail doesn’t log the event.
The following example demonstrates how logging works when you configure logging of Lambda data events for a Lambda function named MyLambdaFunction, but not for all Lambda functions.
- A user runs a script that includes a call to the MyLambdaFunction function and the MyOtherLambdaFunction function.
- The
Invoke
API operation on MyLambdaFunction is an Lambda API. It is recorded as a data event in CloudTrail. Because the CloudTrail user specified logging data events for MyLambdaFunction, any invocations of that function are logged. The trail processes and logs the event. - The
Invoke
API operation on MyOtherLambdaFunction is an Lambda API. Because the CloudTrail user did not specify logging data events for all Lambda functions, theInvoke
operation for MyOtherLambdaFunction does not match the function specified for the trail. The trail doesn’t log the event.
See: newDataResource
smart constructor.
DataResource' | |
|
Instances
newDataResource :: DataResource Source #
Create a value of DataResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:values:DataResource'
, dataResource_values
- 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
.
$sel:type':DataResource'
, dataResource_type
- The resource type in which you want to log data events. You can specify
AWS::S3::Object
, AWS::Lambda::Function
, or AWS::DynamoDB::Table
resources.
The AWS::S3Outposts::Object
, AWS::ManagedBlockchain::Node
,
AWS::S3ObjectLambda::AccessPoint
, and AWS::EC2::Snapshot
resource
types are not valid in basic event selectors. To log data events on
these resource types, use advanced event selectors.
dataResource_values :: Lens' DataResource (Maybe [Text]) Source #
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
.
dataResource_type :: Lens' DataResource (Maybe Text) Source #
The resource type in which you want to log data events. You can specify
AWS::S3::Object
, AWS::Lambda::Function
, or AWS::DynamoDB::Table
resources.
The AWS::S3Outposts::Object
, AWS::ManagedBlockchain::Node
,
AWS::S3ObjectLambda::AccessPoint
, and AWS::EC2::Snapshot
resource
types are not valid in basic event selectors. To log data events on
these resource types, use advanced event selectors.
Event
Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.
See: newEvent
smart constructor.
Event' | |
|
Instances
Create a value of Event
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:username:Event'
, event_username
- A user name or role name of the requester that called the API in the
event returned.
$sel:resources:Event'
, event_resources
- A list of resources referenced by the event returned.
$sel:eventTime:Event'
, event_eventTime
- The date and time of the event returned.
$sel:cloudTrailEvent:Event'
, event_cloudTrailEvent
- A JSON string that contains a representation of the event returned.
$sel:eventName:Event'
, event_eventName
- The name of the event returned.
$sel:readOnly:Event'
, event_readOnly
- Information about whether the event is a write event or a read event.
$sel:accessKeyId:Event'
, event_accessKeyId
- The Amazon Web Services access key ID that was used to sign the request.
If the request was made with temporary security credentials, this is the
access key ID of the temporary credentials.
$sel:eventSource:Event'
, event_eventSource
- The Amazon Web Services service to which the request was made.
$sel:eventId:Event'
, event_eventId
- The CloudTrail ID of the event returned.
event_username :: Lens' Event (Maybe Text) Source #
A user name or role name of the requester that called the API in the event returned.
event_resources :: Lens' Event (Maybe [Resource]) Source #
A list of resources referenced by the event returned.
event_cloudTrailEvent :: Lens' Event (Maybe Text) Source #
A JSON string that contains a representation of the event returned.
event_readOnly :: Lens' Event (Maybe Text) Source #
Information about whether the event is a write event or a read event.
event_accessKeyId :: Lens' Event (Maybe Text) Source #
The Amazon Web Services access key ID that was used to sign the request. If the request was made with temporary security credentials, this is the access key ID of the temporary credentials.
event_eventSource :: Lens' Event (Maybe Text) Source #
The Amazon Web Services service to which the request was made.
EventSelector
data EventSelector Source #
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.
You cannot apply both event selectors and advanced event selectors to a trail.
See: newEventSelector
smart constructor.
EventSelector' | |
|
Instances
newEventSelector :: EventSelector Source #
Create a value of EventSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataResources:EventSelector'
, eventSelector_dataResources
- 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.
$sel:readWriteType:EventSelector'
, eventSelector_readWriteType
- 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
.
$sel:excludeManagementEventSources:EventSelector'
, eventSelector_excludeManagementEventSources
- 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.
$sel:includeManagementEvents:EventSelector'
, eventSelector_includeManagementEvents
- 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.
eventSelector_dataResources :: Lens' EventSelector (Maybe [DataResource]) Source #
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.
eventSelector_readWriteType :: Lens' EventSelector (Maybe ReadWriteType) Source #
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
.
eventSelector_excludeManagementEventSources :: Lens' EventSelector (Maybe [Text]) Source #
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.
eventSelector_includeManagementEvents :: Lens' EventSelector (Maybe Bool) Source #
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.
InsightSelector
data InsightSelector Source #
A JSON string that contains a list of insight types that are logged on a trail.
See: newInsightSelector
smart constructor.
InsightSelector' | |
|
Instances
newInsightSelector :: InsightSelector Source #
Create a value of InsightSelector
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:insightType:InsightSelector'
, insightSelector_insightType
- The type of Insights events to log on a trail. The valid Insights type
in this release is ApiCallRateInsight
.
insightSelector_insightType :: Lens' InsightSelector (Maybe InsightType) Source #
The type of Insights events to log on a trail. The valid Insights type
in this release is ApiCallRateInsight
.
LookupAttribute
data LookupAttribute Source #
Specifies an attribute and value that filter the events returned.
See: newLookupAttribute
smart constructor.
LookupAttribute' | |
|
Instances
Create a value of LookupAttribute
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:attributeKey:LookupAttribute'
, lookupAttribute_attributeKey
- Specifies an attribute on which to filter the events returned.
$sel:attributeValue:LookupAttribute'
, lookupAttribute_attributeValue
- Specifies a value for the specified AttributeKey.
lookupAttribute_attributeKey :: Lens' LookupAttribute LookupAttributeKey Source #
Specifies an attribute on which to filter the events returned.
lookupAttribute_attributeValue :: Lens' LookupAttribute Text Source #
Specifies a value for the specified AttributeKey.
PublicKey
Contains information about a returned public key.
See: newPublicKey
smart constructor.
PublicKey' | |
|
Instances
newPublicKey :: PublicKey Source #
Create a value of PublicKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fingerprint:PublicKey'
, publicKey_fingerprint
- The fingerprint of the public key.
$sel:validityEndTime:PublicKey'
, publicKey_validityEndTime
- The ending time of validity of the public key.
$sel:value:PublicKey'
, publicKey_value
- The DER encoded public key value in PKCS#1 format.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
$sel:validityStartTime:PublicKey'
, publicKey_validityStartTime
- The starting time of validity of the public key.
publicKey_validityEndTime :: Lens' PublicKey (Maybe UTCTime) Source #
The ending time of validity of the public key.
publicKey_value :: Lens' PublicKey (Maybe ByteString) Source #
The DER encoded public key value in PKCS#1 format.--
-- Note: This Lens
automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens
accepts and returns only raw unencoded data.
publicKey_validityStartTime :: Lens' PublicKey (Maybe UTCTime) Source #
The starting time of validity of the public key.
Resource
Specifies the type and name of a resource referenced by an event.
See: newResource
smart constructor.
Resource' | |
|
Instances
Eq Resource Source # | |
Read Resource Source # | |
Show Resource Source # | |
Generic Resource Source # | |
NFData Resource Source # | |
Defined in Amazonka.CloudTrail.Types.Resource | |
Hashable Resource Source # | |
Defined in Amazonka.CloudTrail.Types.Resource | |
FromJSON Resource Source # | |
type Rep Resource Source # | |
Defined in Amazonka.CloudTrail.Types.Resource type Rep Resource = D1 ('MetaData "Resource" "Amazonka.CloudTrail.Types.Resource" "libZSservicesZSamazonka-cloudtrailZSamazonka-cloudtrail" 'False) (C1 ('MetaCons "Resource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
newResource :: Resource Source #
Create a value of Resource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceType:Resource'
, resource_resourceType
- The type of a resource referenced by the event returned. When the
resource type cannot be determined, null is returned. Some examples of
resource types are: Instance for EC2, Trail for CloudTrail,
DBInstance for Amazon RDS, and AccessKey for IAM. To learn more
about how to look up and filter events by the resource types supported
for a service, see
Filtering CloudTrail Events.
$sel:resourceName:Resource'
, resource_resourceName
- The name of the resource referenced by the event returned. These are
user-created names whose values will depend on the environment. For
example, the resource name might be "auto-scaling-test-group" for an
Auto Scaling Group or "i-1234567" for an EC2 Instance.
resource_resourceType :: Lens' Resource (Maybe Text) Source #
The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: Instance for EC2, Trail for CloudTrail, DBInstance for Amazon RDS, and AccessKey for IAM. To learn more about how to look up and filter events by the resource types supported for a service, see Filtering CloudTrail Events.
resource_resourceName :: Lens' Resource (Maybe Text) Source #
The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be "auto-scaling-test-group" for an Auto Scaling Group or "i-1234567" for an EC2 Instance.
ResourceTag
data ResourceTag Source #
A resource tag.
See: newResourceTag
smart constructor.
Instances
newResourceTag :: ResourceTag Source #
Create a value of ResourceTag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceId:ResourceTag'
, resourceTag_resourceId
- Specifies the ARN of the resource.
$sel:tagsList:ResourceTag'
, resourceTag_tagsList
- A list of tags.
resourceTag_resourceId :: Lens' ResourceTag (Maybe Text) Source #
Specifies the ARN of the resource.
resourceTag_tagsList :: Lens' ResourceTag (Maybe [Tag]) Source #
A list of tags.
Tag
A custom key-value pair associated with a resource such as a CloudTrail trail.
See: newTag
smart constructor.
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.CloudTrail.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.CloudTrail.Types.Tag | |
ToJSON Tag Source # | |
Defined in Amazonka.CloudTrail.Types.Tag | |
FromJSON Tag Source # | |
type Rep Tag Source # | |
Defined in Amazonka.CloudTrail.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CloudTrail.Types.Tag" "libZSservicesZSamazonka-cloudtrailZSamazonka-cloudtrail" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Tag'
, tag_value
- The value in a key-value pair of a tag. The value must be no longer than
256 Unicode characters.
$sel:key:Tag'
, tag_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.
tag_value :: Lens' Tag (Maybe Text) Source #
The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
tag_key :: Lens' Tag Text Source #
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.
Trail
The settings for a trail.
See: newTrail
smart constructor.
Trail' | |
|
Instances
Create a value of Trail
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:logFileValidationEnabled:Trail'
, trail_logFileValidationEnabled
- Specifies whether log file validation is enabled.
$sel:trailARN:Trail'
, trail_trailARN
- Specifies the ARN of the trail. The following is the format of a trail
ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
$sel:s3KeyPrefix:Trail'
, trail_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.
The maximum length is 200 characters.
$sel:hasInsightSelectors:Trail'
, trail_hasInsightSelectors
- Specifies whether a trail has insight types specified in an
InsightSelector
list.
$sel:snsTopicARN:Trail'
, trail_snsTopicARN
- Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send
notifications when log files are delivered. The following is the format
of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
$sel:snsTopicName:Trail'
, trail_snsTopicName
- This field is no longer in use. Use SnsTopicARN.
$sel:cloudWatchLogsLogGroupArn:Trail'
, trail_cloudWatchLogsLogGroupArn
- Specifies an Amazon Resource Name (ARN), a unique identifier that
represents the log group to which CloudTrail logs will be delivered.
$sel:kmsKeyId:Trail'
, trail_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 following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
$sel:homeRegion:Trail'
, trail_homeRegion
- The region in which the trail was created.
$sel:name:Trail'
, trail_name
- Name of the trail set by calling CreateTrail. The maximum length is 128
characters.
$sel:includeGlobalServiceEvents:Trail'
, trail_includeGlobalServiceEvents
- Set to True to include Amazon Web Services API calls from Amazon Web
Services global services such as IAM. Otherwise, False.
$sel:hasCustomEventSelectors:Trail'
, trail_hasCustomEventSelectors
- Specifies if the trail has custom event selectors.
$sel:isOrganizationTrail:Trail'
, trail_isOrganizationTrail
- Specifies whether the trail is an organization trail.
$sel:cloudWatchLogsRoleArn:Trail'
, trail_cloudWatchLogsRoleArn
- Specifies the role for the CloudWatch Logs endpoint to assume to write
to a user's log group.
$sel:s3BucketName:Trail'
, trail_s3BucketName
- Name of the Amazon S3 bucket into which CloudTrail delivers your trail
files. See
Amazon S3 Bucket Naming Requirements.
$sel:isMultiRegionTrail:Trail'
, trail_isMultiRegionTrail
- Specifies whether the trail exists only in one region or exists in all
regions.
trail_logFileValidationEnabled :: Lens' Trail (Maybe Bool) Source #
Specifies whether log file validation is enabled.
trail_trailARN :: Lens' Trail (Maybe Text) Source #
Specifies the ARN of the trail. The following is the format of a trail ARN.
arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail
trail_s3KeyPrefix :: Lens' Trail (Maybe Text) Source #
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.
trail_hasInsightSelectors :: Lens' Trail (Maybe Bool) Source #
Specifies whether a trail has insight types specified in an
InsightSelector
list.
trail_snsTopicARN :: Lens' Trail (Maybe Text) Source #
Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The following is the format of a topic ARN.
arn:aws:sns:us-east-2:123456789012:MyTopic
trail_snsTopicName :: Lens' Trail (Maybe Text) Source #
This field is no longer in use. Use SnsTopicARN.
trail_cloudWatchLogsLogGroupArn :: Lens' Trail (Maybe Text) Source #
Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.
trail_kmsKeyId :: Lens' Trail (Maybe Text) Source #
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 following format.
arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
trail_name :: Lens' Trail (Maybe Text) Source #
Name of the trail set by calling CreateTrail. The maximum length is 128 characters.
trail_includeGlobalServiceEvents :: Lens' Trail (Maybe Bool) Source #
Set to True to include Amazon Web Services API calls from Amazon Web Services global services such as IAM. Otherwise, False.
trail_hasCustomEventSelectors :: Lens' Trail (Maybe Bool) Source #
Specifies if the trail has custom event selectors.
trail_isOrganizationTrail :: Lens' Trail (Maybe Bool) Source #
Specifies whether the trail is an organization trail.
trail_cloudWatchLogsRoleArn :: Lens' Trail (Maybe Text) Source #
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
trail_s3BucketName :: Lens' Trail (Maybe Text) Source #
Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See Amazon S3 Bucket Naming Requirements.
trail_isMultiRegionTrail :: Lens' Trail (Maybe Bool) Source #
Specifies whether the trail exists only in one region or exists in all regions.
TrailInfo
Information about a CloudTrail trail, including the trail's name, home region, and Amazon Resource Name (ARN).
See: newTrailInfo
smart constructor.
Instances
Eq TrailInfo Source # | |
Read TrailInfo Source # | |
Show TrailInfo Source # | |
Generic TrailInfo Source # | |
NFData TrailInfo Source # | |
Defined in Amazonka.CloudTrail.Types.TrailInfo | |
Hashable TrailInfo Source # | |
Defined in Amazonka.CloudTrail.Types.TrailInfo | |
FromJSON TrailInfo Source # | |
type Rep TrailInfo Source # | |
Defined in Amazonka.CloudTrail.Types.TrailInfo type Rep TrailInfo = D1 ('MetaData "TrailInfo" "Amazonka.CloudTrail.Types.TrailInfo" "libZSservicesZSamazonka-cloudtrailZSamazonka-cloudtrail" 'False) (C1 ('MetaCons "TrailInfo'" 'PrefixI 'True) (S1 ('MetaSel ('Just "trailARN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "homeRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) |
newTrailInfo :: TrailInfo Source #
Create a value of TrailInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:trailARN:TrailInfo'
, trailInfo_trailARN
- The ARN of a trail.
$sel:homeRegion:TrailInfo'
, trailInfo_homeRegion
- The Amazon Web Services Region in which a trail was created.
$sel:name:TrailInfo'
, trailInfo_name
- The name of a trail.