Network.AWS.CloudTrail.CreateTrail

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

Creating a Request

createTrail

Arguments

:: Text

ctName

-> Text

ctS3BucketName

-> CreateTrail

Creates a value of CreateTrail with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ctS3KeyPrefix - 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.
• ctSNSTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
• ctEnableLogFileValidation - Specifies whether log file integrity validation is enabled. The default is false.
• ctCloudWatchLogsLogGroupARN - 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.
• ctKMSKeyId - 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. Examples: * aliasMyAliasName * arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * 12345678-1234-1234-1234-123456789012
• ctIncludeGlobalServiceEvents - Specifies whether the trail is publishing events from global services such as IAM to the log files.
• ctCloudWatchLogsRoleARN - Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
• ctIsMultiRegionTrail - Specifies whether the trail is created in the current region or in all regions. The default is false.
• ctName - 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 invalid. * Not be in IP address format (for example, 192.168.5.4)
• ctS3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements .

data CreateTrail

Specifies the settings for each trail.

See: createTrail smart constructor.

Instances

Eq CreateTrail

Methods

(==) :: CreateTrail -> CreateTrail -> Bool

(/=) :: CreateTrail -> CreateTrail -> Bool

Data CreateTrail

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateTrail -> c CreateTrail

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateTrail

toConstr :: CreateTrail -> Constr

dataTypeOf :: CreateTrail -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateTrail)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateTrail)

gmapT :: (forall b. Data b => b -> b) -> CreateTrail -> CreateTrail

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateTrail -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateTrail -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateTrail -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateTrail -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateTrail -> m CreateTrail

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateTrail -> m CreateTrail

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateTrail -> m CreateTrail

Read CreateTrail

Methods

readsPrec :: Int -> ReadS CreateTrail

readList :: ReadS [CreateTrail]

readPrec :: ReadPrec CreateTrail

readListPrec :: ReadPrec [CreateTrail]

Show CreateTrail

Methods

showsPrec :: Int -> CreateTrail -> ShowS

show :: CreateTrail -> String

showList :: [CreateTrail] -> ShowS

Generic CreateTrail

Associated Types

type Rep CreateTrail :: * -> *

Methods

from :: CreateTrail -> Rep CreateTrail x

to :: Rep CreateTrail x -> CreateTrail

Hashable CreateTrail

Methods

hashWithSalt :: Int -> CreateTrail -> Int

hash :: CreateTrail -> Int

ToJSON CreateTrail

Methods

toJSON :: CreateTrail -> Value

toEncoding :: CreateTrail -> Encoding

toJSONList :: [CreateTrail] -> Value

toEncodingList :: [CreateTrail] -> Encoding

NFData CreateTrail

Methods

rnf :: CreateTrail -> ()

AWSRequest CreateTrail

Associated Types

type Rs CreateTrail :: *

Methods

request :: CreateTrail -> Request CreateTrail

response :: MonadResource m => Logger -> Service -> Proxy * CreateTrail -> ClientResponse -> m (Response CreateTrail)

ToQuery CreateTrail

Methods

toQuery :: CreateTrail -> QueryString

ToPath CreateTrail

Methods

toPath :: CreateTrail -> ByteString

ToHeaders CreateTrail

Methods

toHeaders :: CreateTrail -> [Header]

type Rep CreateTrail

type Rep CreateTrail = D1 (MetaData "CreateTrail" "Network.AWS.CloudTrail.CreateTrail" "amazonka-cloudtrail-1.5.0-GT2y6tjh7SRBi5UfY2VBo1" False) (C1 (MetaCons "CreateTrail'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ctS3KeyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ctSNSTopicName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ctEnableLogFileValidation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_ctCloudWatchLogsLogGroupARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ctKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ctIncludeGlobalServiceEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_ctCloudWatchLogsRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ctIsMultiRegionTrail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_ctName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_ctS3BucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs CreateTrail

type Rs CreateTrail = CreateTrailResponse

Request Lenses

ctS3KeyPrefix :: Lens' CreateTrail (Maybe Text)

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.

ctSNSTopicName :: Lens' CreateTrail (Maybe Text)

Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

ctEnableLogFileValidation :: Lens' CreateTrail (Maybe Bool)

Specifies whether log file integrity validation is enabled. The default is false.

ctCloudWatchLogsLogGroupARN :: Lens' CreateTrail (Maybe Text)

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.

ctKMSKeyId :: Lens' CreateTrail (Maybe Text)

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. Examples: * aliasMyAliasName * arn:aws:kms:us-east-1:123456789012:aliasMyAliasName * arn:aws:kms:us-east-1:123456789012:key12345678-1234-1234-1234-123456789012 * 12345678-1234-1234-1234-123456789012

ctIncludeGlobalServiceEvents :: Lens' CreateTrail (Maybe Bool)

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

ctCloudWatchLogsRoleARN :: Lens' CreateTrail (Maybe Text)

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

ctIsMultiRegionTrail :: Lens' CreateTrail (Maybe Bool)

Specifies whether the trail is created in the current region or in all regions. The default is false.

ctName :: Lens' CreateTrail Text

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 invalid. * Not be in IP address format (for example, 192.168.5.4)

ctS3BucketName :: Lens' CreateTrail Text

Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements .

Destructuring the Response

createTrailResponse

Arguments

:: Int

ctrsResponseStatus

-> CreateTrailResponse

Creates a value of CreateTrailResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ctrsLogFileValidationEnabled - Specifies whether log file integrity validation is enabled.
• ctrsTrailARN - Specifies the ARN of the trail that was created. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail
• ctrsS3KeyPrefix - 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 .
• ctrsSNSTopicARN - Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is: arn:aws:sns:us-east-1:123456789012:MyTopic
• ctrsSNSTopicName - This field is deprecated. Use SnsTopicARN.
• ctrsCloudWatchLogsLogGroupARN - Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.
• ctrsKMSKeyId - Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
• ctrsName - Specifies the name of the trail.
• ctrsIncludeGlobalServiceEvents - Specifies whether the trail is publishing events from global services such as IAM to the log files.
• ctrsCloudWatchLogsRoleARN - Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
• ctrsS3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log files.
• ctrsIsMultiRegionTrail - Specifies whether the trail exists in one region or in all regions.
• ctrsResponseStatus - -- | The response status code.

data CreateTrailResponse

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

See: createTrailResponse smart constructor.

Instances

Eq CreateTrailResponse

Methods

(==) :: CreateTrailResponse -> CreateTrailResponse -> Bool

(/=) :: CreateTrailResponse -> CreateTrailResponse -> Bool

Data CreateTrailResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateTrailResponse -> c CreateTrailResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateTrailResponse

toConstr :: CreateTrailResponse -> Constr

dataTypeOf :: CreateTrailResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateTrailResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateTrailResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateTrailResponse -> CreateTrailResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateTrailResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateTrailResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateTrailResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateTrailResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateTrailResponse -> m CreateTrailResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateTrailResponse -> m CreateTrailResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateTrailResponse -> m CreateTrailResponse

Read CreateTrailResponse

Methods

readsPrec :: Int -> ReadS CreateTrailResponse

readList :: ReadS [CreateTrailResponse]

readPrec :: ReadPrec CreateTrailResponse

readListPrec :: ReadPrec [CreateTrailResponse]

Show CreateTrailResponse

Methods

showsPrec :: Int -> CreateTrailResponse -> ShowS

show :: CreateTrailResponse -> String

showList :: [CreateTrailResponse] -> ShowS

Generic CreateTrailResponse

Associated Types

type Rep CreateTrailResponse :: * -> *

Methods

from :: CreateTrailResponse -> Rep CreateTrailResponse x

to :: Rep CreateTrailResponse x -> CreateTrailResponse

NFData CreateTrailResponse

Methods

rnf :: CreateTrailResponse -> ()

type Rep CreateTrailResponse

type Rep CreateTrailResponse = D1 (MetaData "CreateTrailResponse" "Network.AWS.CloudTrail.CreateTrail" "amazonka-cloudtrail-1.5.0-GT2y6tjh7SRBi5UfY2VBo1" False) (C1 (MetaCons "CreateTrailResponse'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ctrsLogFileValidationEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_ctrsTrailARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ctrsS3KeyPrefix") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_ctrsSNSTopicARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ctrsSNSTopicName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ctrsCloudWatchLogsLogGroupARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ctrsKMSKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_ctrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ctrsIncludeGlobalServiceEvents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ctrsCloudWatchLogsRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ctrsS3BucketName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ctrsIsMultiRegionTrail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_ctrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))))

Response Lenses

ctrsLogFileValidationEnabled :: Lens' CreateTrailResponse (Maybe Bool)

Specifies whether log file integrity validation is enabled.

ctrsTrailARN :: Lens' CreateTrailResponse (Maybe Text)

Specifies the ARN of the trail that was created. The format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail

ctrsS3KeyPrefix :: Lens' CreateTrailResponse (Maybe Text)

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 .

ctrsSNSTopicARN :: Lens' CreateTrailResponse (Maybe Text)

Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is: arn:aws:sns:us-east-1:123456789012:MyTopic

ctrsSNSTopicName :: Lens' CreateTrailResponse (Maybe Text)

This field is deprecated. Use SnsTopicARN.

ctrsCloudWatchLogsLogGroupARN :: Lens' CreateTrailResponse (Maybe Text)

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

ctrsKMSKeyId :: Lens' CreateTrailResponse (Maybe Text)

Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

ctrsName :: Lens' CreateTrailResponse (Maybe Text)

Specifies the name of the trail.

ctrsIncludeGlobalServiceEvents :: Lens' CreateTrailResponse (Maybe Bool)

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

ctrsCloudWatchLogsRoleARN :: Lens' CreateTrailResponse (Maybe Text)

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

ctrsS3BucketName :: Lens' CreateTrailResponse (Maybe Text)

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

ctrsIsMultiRegionTrail :: Lens' CreateTrailResponse (Maybe Bool)

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

ctrsResponseStatus :: Lens' CreateTrailResponse Int

• - | The response status code.