Documentation ¶
Overview ¶
Package cloudtrail provides the client and types for making API requests to AWS CloudTrail.
This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.
CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.
As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page (http://aws.amazon.com/tools/).
See the AWS CloudTrail User Guide (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html) for information about the data that is included with each AWS API call listed in the log files.
See https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01 for more information on this service.
See cloudtrail package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudtrail/
Using the Client ¶
To AWS CloudTrail with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS CloudTrail client CloudTrail for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudtrail/#New
Index ¶
- Constants
- type AddTagsInput
- type AddTagsOutput
- type AddTagsRequest
- type CloudTrail
- func (c *CloudTrail) AddTagsRequest(input *AddTagsInput) AddTagsRequest
- func (c *CloudTrail) CreateTrailRequest(input *CreateTrailInput) CreateTrailRequest
- func (c *CloudTrail) DeleteTrailRequest(input *DeleteTrailInput) DeleteTrailRequest
- func (c *CloudTrail) DescribeTrailsRequest(input *DescribeTrailsInput) DescribeTrailsRequest
- func (c *CloudTrail) GetEventSelectorsRequest(input *GetEventSelectorsInput) GetEventSelectorsRequest
- func (c *CloudTrail) GetTrailStatusRequest(input *GetTrailStatusInput) GetTrailStatusRequest
- func (c *CloudTrail) ListPublicKeysRequest(input *ListPublicKeysInput) ListPublicKeysRequest
- func (c *CloudTrail) ListTagsRequest(input *ListTagsInput) ListTagsRequest
- func (c *CloudTrail) LookupEventsRequest(input *LookupEventsInput) LookupEventsRequest
- func (c *CloudTrail) PutEventSelectorsRequest(input *PutEventSelectorsInput) PutEventSelectorsRequest
- func (c *CloudTrail) RemoveTagsRequest(input *RemoveTagsInput) RemoveTagsRequest
- func (c *CloudTrail) StartLoggingRequest(input *StartLoggingInput) StartLoggingRequest
- func (c *CloudTrail) StopLoggingRequest(input *StopLoggingInput) StopLoggingRequest
- func (c *CloudTrail) UpdateTrailRequest(input *UpdateTrailInput) UpdateTrailRequest
- type CreateTrailInput
- type CreateTrailOutput
- type CreateTrailRequest
- type DataResource
- type DeleteTrailInput
- type DeleteTrailOutput
- type DeleteTrailRequest
- type DescribeTrailsInput
- type DescribeTrailsOutput
- type DescribeTrailsRequest
- type Event
- type EventSelector
- type GetEventSelectorsInput
- type GetEventSelectorsOutput
- type GetEventSelectorsRequest
- type GetTrailStatusInput
- type GetTrailStatusOutput
- type GetTrailStatusRequest
- type ListPublicKeysInput
- type ListPublicKeysOutput
- type ListPublicKeysRequest
- type ListTagsInput
- type ListTagsOutput
- type ListTagsRequest
- type LookupAttribute
- type LookupAttributeKey
- type LookupEventsInput
- type LookupEventsOutput
- type LookupEventsPager
- type LookupEventsRequest
- type PublicKey
- type PutEventSelectorsInput
- type PutEventSelectorsOutput
- type PutEventSelectorsRequest
- type ReadWriteType
- type RemoveTagsInput
- type RemoveTagsOutput
- type RemoveTagsRequest
- type Resource
- type ResourceTag
- type StartLoggingInput
- type StartLoggingOutput
- type StartLoggingRequest
- type StopLoggingInput
- type StopLoggingOutput
- type StopLoggingRequest
- type Tag
- type Trail
- type UpdateTrailInput
- type UpdateTrailOutput
- type UpdateTrailRequest
Constants ¶
const ( // ErrCodeARNInvalidException for service response error code // "ARNInvalidException". // // This exception is thrown when an operation is called with an invalid trail // ARN. The format of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail ErrCodeARNInvalidException = "ARNInvalidException" // "CloudWatchLogsDeliveryUnavailableException". // // Cannot set a CloudWatch Logs delivery for this region. ErrCodeCloudWatchLogsDeliveryUnavailableException = "CloudWatchLogsDeliveryUnavailableException" // ErrCodeInsufficientEncryptionPolicyException for service response error code // "InsufficientEncryptionPolicyException". // // This exception is thrown when the policy on the S3 bucket or KMS key is not // sufficient. ErrCodeInsufficientEncryptionPolicyException = "InsufficientEncryptionPolicyException" // ErrCodeInsufficientS3BucketPolicyException for service response error code // "InsufficientS3BucketPolicyException". // // This exception is thrown when the policy on the S3 bucket is not sufficient. ErrCodeInsufficientS3BucketPolicyException = "InsufficientS3BucketPolicyException" // ErrCodeInsufficientSnsTopicPolicyException for service response error code // "InsufficientSnsTopicPolicyException". // // This exception is thrown when the policy on the SNS topic is not sufficient. ErrCodeInsufficientSnsTopicPolicyException = "InsufficientSnsTopicPolicyException" // ErrCodeInvalidCloudWatchLogsLogGroupArnException for service response error code // "InvalidCloudWatchLogsLogGroupArnException". // // This exception is thrown when the provided CloudWatch log group is not valid. ErrCodeInvalidCloudWatchLogsLogGroupArnException = "InvalidCloudWatchLogsLogGroupArnException" // ErrCodeInvalidCloudWatchLogsRoleArnException for service response error code // "InvalidCloudWatchLogsRoleArnException". // // This exception is thrown when the provided role is not valid. ErrCodeInvalidCloudWatchLogsRoleArnException = "InvalidCloudWatchLogsRoleArnException" // ErrCodeInvalidEventSelectorsException for service response error code // "InvalidEventSelectorsException". // // This exception is thrown when the PutEventSelectors operation is called with // an invalid number of event selectors, data resources, or an invalid value // for a parameter: // // * 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. // // * Specify a valid value for a parameter. For example, specifying the ReadWriteType // parameter with a value of read-only is invalid. ErrCodeInvalidEventSelectorsException = "InvalidEventSelectorsException" // ErrCodeInvalidHomeRegionException for service response error code // "InvalidHomeRegionException". // // 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. ErrCodeInvalidHomeRegionException = "InvalidHomeRegionException" // ErrCodeInvalidKmsKeyIdException for service response error code // "InvalidKmsKeyIdException". // // This exception is thrown when the KMS key ARN is invalid. ErrCodeInvalidKmsKeyIdException = "InvalidKmsKeyIdException" // ErrCodeInvalidLookupAttributesException for service response error code // "InvalidLookupAttributesException". // // Occurs when an invalid lookup attribute is specified. ErrCodeInvalidLookupAttributesException = "InvalidLookupAttributesException" // ErrCodeInvalidMaxResultsException for service response error code // "InvalidMaxResultsException". // // This exception is thrown if the limit specified is invalid. ErrCodeInvalidMaxResultsException = "InvalidMaxResultsException" // ErrCodeInvalidNextTokenException for service response error code // "InvalidNextTokenException". // // Invalid token or token that was previously used in a request with different // parameters. This exception is thrown if the token is invalid. ErrCodeInvalidNextTokenException = "InvalidNextTokenException" // ErrCodeInvalidParameterCombinationException for service response error code // "InvalidParameterCombinationException". // // This exception is thrown when the combination of parameters provided is not // valid. ErrCodeInvalidParameterCombinationException = "InvalidParameterCombinationException" // ErrCodeInvalidS3BucketNameException for service response error code // "InvalidS3BucketNameException". // // This exception is thrown when the provided S3 bucket name is not valid. ErrCodeInvalidS3BucketNameException = "InvalidS3BucketNameException" // ErrCodeInvalidS3PrefixException for service response error code // "InvalidS3PrefixException". // // This exception is thrown when the provided S3 prefix is not valid. ErrCodeInvalidS3PrefixException = "InvalidS3PrefixException" // ErrCodeInvalidSnsTopicNameException for service response error code // "InvalidSnsTopicNameException". // // This exception is thrown when the provided SNS topic name is not valid. ErrCodeInvalidSnsTopicNameException = "InvalidSnsTopicNameException" // ErrCodeInvalidTagParameterException for service response error code // "InvalidTagParameterException". // // This exception is thrown when the key or value specified for the tag does // not match the regular expression ^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$. ErrCodeInvalidTagParameterException = "InvalidTagParameterException" // ErrCodeInvalidTimeRangeException for service response error code // "InvalidTimeRangeException". // // Occurs if the timestamp values are invalid. Either the start time occurs // after the end time or the time range is outside the range of possible values. ErrCodeInvalidTimeRangeException = "InvalidTimeRangeException" // ErrCodeInvalidTokenException for service response error code // "InvalidTokenException". // // Reserved for future use. ErrCodeInvalidTokenException = "InvalidTokenException" // ErrCodeInvalidTrailNameException for service response error code // "InvalidTrailNameException". // // 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 // and my--namespace are invalid. // // * Not be in IP address format (for example, 192.168.5.4) ErrCodeInvalidTrailNameException = "InvalidTrailNameException" // ErrCodeKmsException for service response error code // "KmsException". // // This exception is thrown when there is an issue with the specified KMS key // and the trail can’t be updated. ErrCodeKmsException = "KmsException" // ErrCodeKmsKeyDisabledException for service response error code // "KmsKeyDisabledException". // // This exception is deprecated. ErrCodeKmsKeyDisabledException = "KmsKeyDisabledException" // ErrCodeKmsKeyNotFoundException for service response error code // "KmsKeyNotFoundException". // // This exception is thrown when the KMS key does not exist, or when the S3 // bucket and the KMS key are not in the same region. ErrCodeKmsKeyNotFoundException = "KmsKeyNotFoundException" // ErrCodeMaximumNumberOfTrailsExceededException for service response error code // "MaximumNumberOfTrailsExceededException". // // This exception is thrown when the maximum number of trails is reached. ErrCodeMaximumNumberOfTrailsExceededException = "MaximumNumberOfTrailsExceededException" // ErrCodeOperationNotPermittedException for service response error code // "OperationNotPermittedException". // // This exception is thrown when the requested operation is not permitted. ErrCodeOperationNotPermittedException = "OperationNotPermittedException" // ErrCodeResourceNotFoundException for service response error code // "ResourceNotFoundException". // // This exception is thrown when the specified resource is not found. ErrCodeResourceNotFoundException = "ResourceNotFoundException" // ErrCodeResourceTypeNotSupportedException for service response error code // "ResourceTypeNotSupportedException". // // This exception is thrown when the specified resource type is not supported // by CloudTrail. ErrCodeResourceTypeNotSupportedException = "ResourceTypeNotSupportedException" // ErrCodeS3BucketDoesNotExistException for service response error code // "S3BucketDoesNotExistException". // // This exception is thrown when the specified S3 bucket does not exist. ErrCodeS3BucketDoesNotExistException = "S3BucketDoesNotExistException" // ErrCodeTagsLimitExceededException for service response error code // "TagsLimitExceededException". // // The number of tags per trail has exceeded the permitted amount. Currently, // the limit is 50. ErrCodeTagsLimitExceededException = "TagsLimitExceededException" // ErrCodeTrailAlreadyExistsException for service response error code // "TrailAlreadyExistsException". // // This exception is thrown when the specified trail already exists. ErrCodeTrailAlreadyExistsException = "TrailAlreadyExistsException" // ErrCodeTrailNotFoundException for service response error code // "TrailNotFoundException". // // This exception is thrown when the trail with the given name is not found. ErrCodeTrailNotFoundException = "TrailNotFoundException" // ErrCodeTrailNotProvidedException for service response error code // "TrailNotProvidedException". // // This exception is deprecated. ErrCodeTrailNotProvidedException = "TrailNotProvidedException" // ErrCodeUnsupportedOperationException for service response error code // "UnsupportedOperationException". // // This exception is thrown when the requested operation is not supported. ErrCodeUnsupportedOperationException = "UnsupportedOperationException" )
const ( ServiceName = "cloudtrail" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddTagsInput ¶
type AddTagsInput struct { // Specifies the ARN of the trail to which one or more tags will be added. The // format of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // Contains a list of CloudTrail tags, up to a limit of 50 TagsList []Tag `type:"list"` // contains filtered or unexported fields }
Specifies the tags to add to a trail. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/AddTagsRequest
func (AddTagsInput) GoString ¶
func (s AddTagsInput) GoString() string
GoString returns the string representation
func (AddTagsInput) String ¶
func (s AddTagsInput) String() string
String returns the string representation
func (*AddTagsInput) Validate ¶
func (s *AddTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddTagsOutput ¶
type AddTagsOutput struct {
// contains filtered or unexported fields
}
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/AddTagsResponse
func (AddTagsOutput) GoString ¶
func (s AddTagsOutput) GoString() string
GoString returns the string representation
func (AddTagsOutput) SDKResponseMetadata ¶
func (s AddTagsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (AddTagsOutput) String ¶
func (s AddTagsOutput) String() string
String returns the string representation
type AddTagsRequest ¶
type AddTagsRequest struct { *aws.Request Input *AddTagsInput Copy func(*AddTagsInput) AddTagsRequest }
AddTagsRequest is a API request type for the AddTags API operation.
func (AddTagsRequest) Send ¶
func (r AddTagsRequest) Send() (*AddTagsOutput, error)
Send marshals and sends the AddTags API request.
type CloudTrail ¶
CloudTrail provides the API operation methods for making requests to AWS CloudTrail. See this package's package overview docs for details on the service.
CloudTrail methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(config aws.Config) *CloudTrail
New creates a new instance of the CloudTrail client with a config.
Example:
// Create a CloudTrail client from just a config. svc := cloudtrail.New(myConfig)
func (*CloudTrail) AddTagsRequest ¶
func (c *CloudTrail) AddTagsRequest(input *AddTagsInput) AddTagsRequest
AddTagsRequest returns a request value for making API operation for AWS CloudTrail.
Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).
// Example sending a request using the AddTagsRequest method. req := client.AddTagsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/AddTags
func (*CloudTrail) CreateTrailRequest ¶
func (c *CloudTrail) CreateTrailRequest(input *CreateTrailInput) CreateTrailRequest
CreateTrailRequest returns a request value for making API operation for AWS CloudTrail.
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.
// Example sending a request using the CreateTrailRequest method. req := client.CreateTrailRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateTrail
func (*CloudTrail) DeleteTrailRequest ¶
func (c *CloudTrail) DeleteTrailRequest(input *DeleteTrailInput) DeleteTrailRequest
DeleteTrailRequest returns a request value for making API operation for AWS CloudTrail.
Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
// Example sending a request using the DeleteTrailRequest method. req := client.DeleteTrailRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteTrail
func (*CloudTrail) DescribeTrailsRequest ¶
func (c *CloudTrail) DescribeTrailsRequest(input *DescribeTrailsInput) DescribeTrailsRequest
DescribeTrailsRequest returns a request value for making API operation for AWS CloudTrail.
Retrieves settings for the trail associated with the current region for your account.
// Example sending a request using the DescribeTrailsRequest method. req := client.DescribeTrailsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeTrails
func (*CloudTrail) GetEventSelectorsRequest ¶
func (c *CloudTrail) GetEventSelectorsRequest(input *GetEventSelectorsInput) GetEventSelectorsRequest
GetEventSelectorsRequest returns a request value for making API operation for AWS CloudTrail.
Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:
The S3 objects that you are logging for data events.
If your event selector includes management events.
If your event selector includes read-only events, write-only events, or all.
For more information, see Logging Data and Management Events for Trails (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html) in the AWS CloudTrail User Guide.
// Example sending a request using the GetEventSelectorsRequest method. req := client.GetEventSelectorsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventSelectors
func (*CloudTrail) GetTrailStatusRequest ¶
func (c *CloudTrail) GetTrailStatusRequest(input *GetTrailStatusInput) GetTrailStatusRequest
GetTrailStatusRequest returns a request value for making API operation for AWS CloudTrail.
Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.
// Example sending a request using the GetTrailStatusRequest method. req := client.GetTrailStatusRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrailStatus
func (*CloudTrail) ListPublicKeysRequest ¶
func (c *CloudTrail) ListPublicKeysRequest(input *ListPublicKeysInput) ListPublicKeysRequest
ListPublicKeysRequest returns a request value for making API operation for AWS CloudTrail.
Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.
CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.
// Example sending a request using the ListPublicKeysRequest method. req := client.ListPublicKeysRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListPublicKeys
func (*CloudTrail) ListTagsRequest ¶
func (c *CloudTrail) ListTagsRequest(input *ListTagsInput) ListTagsRequest
ListTagsRequest returns a request value for making API operation for AWS CloudTrail.
Lists the tags for the trail in the current region.
// Example sending a request using the ListTagsRequest method. req := client.ListTagsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListTags
func (*CloudTrail) LookupEventsRequest ¶
func (c *CloudTrail) LookupEventsRequest(input *LookupEventsInput) LookupEventsRequest
LookupEventsRequest returns a request value for making API operation for AWS CloudTrail.
Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:
Event ID
Event name
Event source
Resource name
Resource type
User name
All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.
The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.
Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.
// Example sending a request using the LookupEventsRequest method. req := client.LookupEventsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/LookupEvents
func (*CloudTrail) PutEventSelectorsRequest ¶
func (c *CloudTrail) PutEventSelectorsRequest(input *PutEventSelectorsInput) PutEventSelectorsRequest
PutEventSelectorsRequest returns a request value for making API operation for AWS CloudTrail.
Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selectors in 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.
Example ¶
You create an event selector for a trail and specify that you want write-only events.
The EC2 GetConsoleOutput and RunInstances API operations occur in your account.
CloudTrail evaluates whether the events match your event selectors.
The RunInstances is a write-only event and it matches your event selector. The trail logs the event.
The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event.
The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.
You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html) in the AWS CloudTrail User Guide.
// Example sending a request using the PutEventSelectorsRequest method. req := client.PutEventSelectorsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutEventSelectors
func (*CloudTrail) RemoveTagsRequest ¶
func (c *CloudTrail) RemoveTagsRequest(input *RemoveTagsInput) RemoveTagsRequest
RemoveTagsRequest returns a request value for making API operation for AWS CloudTrail.
Removes the specified tags from a trail.
// Example sending a request using the RemoveTagsRequest method. req := client.RemoveTagsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RemoveTags
func (*CloudTrail) StartLoggingRequest ¶
func (c *CloudTrail) StartLoggingRequest(input *StartLoggingInput) StartLoggingRequest
StartLoggingRequest returns a request value for making API operation for AWS CloudTrail.
Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.
// Example sending a request using the StartLoggingRequest method. req := client.StartLoggingRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartLogging
func (*CloudTrail) StopLoggingRequest ¶
func (c *CloudTrail) StopLoggingRequest(input *StopLoggingInput) StopLoggingRequest
StopLoggingRequest returns a request value for making API operation for AWS CloudTrail.
Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.
// Example sending a request using the StopLoggingRequest method. req := client.StopLoggingRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StopLogging
func (*CloudTrail) UpdateTrailRequest ¶
func (c *CloudTrail) UpdateTrailRequest(input *UpdateTrailInput) UpdateTrailRequest
UpdateTrailRequest returns a request value for making API operation for AWS CloudTrail.
Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.
// Example sending a request using the UpdateTrailRequest method. req := client.UpdateTrailRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateTrail
type CreateTrailInput ¶
type CreateTrailInput struct { // 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. CloudWatchLogsLogGroupArn *string `type:"string"` // Specifies the role for the CloudWatch Logs endpoint to assume to write to // a user's log group. CloudWatchLogsRoleArn *string `type:"string"` // Specifies whether log file integrity validation is enabled. The default is // false. // // When you disable log file integrity validation, the chain of digest files // is broken after one hour. CloudTrail will not create digest files for log // files that were delivered during a period in which log file integrity validation // was disabled. For example, if you enable log file integrity validation at // noon on January 1, disable it at noon on January 2, and re-enable it at noon // on January 10, digest files will not be created for the log files delivered // from noon on January 2 to noon on January 10. The same applies whenever you // stop CloudTrail logging or delete a trail. EnableLogFileValidation *bool `type:"boolean"` // Specifies whether the trail is publishing events from global services such // as IAM to the log files. IncludeGlobalServiceEvents *bool `type:"boolean"` // Specifies whether the trail is created in the current region or in all regions. // The default is false. IsMultiRegionTrail *bool `type:"boolean"` // 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: // // * alias/MyAliasName // // * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName // // * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 // // * 12345678-1234-1234-1234-123456789012 KmsKeyId *string `type:"string"` // 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) // // Name is a required field Name *string `type:"string" required:"true"` // Specifies the name of the Amazon S3 bucket designated for publishing log // files. See Amazon S3 Bucket Naming Requirements (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). // // S3BucketName is a required field S3BucketName *string `type:"string" required:"true"` // 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 (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). // The maximum length is 200 characters. S3KeyPrefix *string `type:"string"` // Specifies the name of the Amazon SNS topic defined for notification of log // file delivery. The maximum length is 256 characters. SnsTopicName *string `type:"string"` // contains filtered or unexported fields }
Specifies the settings for each trail. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateTrailRequest
func (CreateTrailInput) GoString ¶
func (s CreateTrailInput) GoString() string
GoString returns the string representation
func (CreateTrailInput) String ¶
func (s CreateTrailInput) String() string
String returns the string representation
func (*CreateTrailInput) Validate ¶
func (s *CreateTrailInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateTrailOutput ¶
type CreateTrailOutput struct { // Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail // logs will be delivered. CloudWatchLogsLogGroupArn *string `type:"string"` // Specifies the role for the CloudWatch Logs endpoint to assume to write to // a user's log group. CloudWatchLogsRoleArn *string `type:"string"` // Specifies whether the trail is publishing events from global services such // as IAM to the log files. IncludeGlobalServiceEvents *bool `type:"boolean"` // Specifies whether the trail exists in one region or in all regions. IsMultiRegionTrail *bool `type:"boolean"` // 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 KmsKeyId *string `type:"string"` // Specifies whether log file integrity validation is enabled. LogFileValidationEnabled *bool `type:"boolean"` // Specifies the name of the trail. Name *string `type:"string"` // Specifies the name of the Amazon S3 bucket designated for publishing log // files. S3BucketName *string `type:"string"` // 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 (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). S3KeyPrefix *string `type:"string"` // 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 SnsTopicARN *string `type:"string"` // This field is deprecated. Use SnsTopicARN. SnsTopicName *string `deprecated:"true" type:"string"` // 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 TrailARN *string `type:"string"` // contains filtered or unexported fields }
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/CreateTrailResponse
func (CreateTrailOutput) GoString ¶
func (s CreateTrailOutput) GoString() string
GoString returns the string representation
func (CreateTrailOutput) SDKResponseMetadata ¶
func (s CreateTrailOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateTrailOutput) String ¶
func (s CreateTrailOutput) String() string
String returns the string representation
type CreateTrailRequest ¶
type CreateTrailRequest struct { *aws.Request Input *CreateTrailInput Copy func(*CreateTrailInput) CreateTrailRequest }
CreateTrailRequest is a API request type for the CreateTrail API operation.
func (CreateTrailRequest) Send ¶
func (r CreateTrailRequest) Send() (*CreateTrailOutput, error)
Send marshals and sends the CreateTrail API request.
type DataResource ¶
type DataResource struct { // The resource type in which you want to log data events. You can specify only // the following value: AWS::S3::Object. Type *string `type:"string"` // A list of ARN-like strings for the specified S3 objects. // // 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. Values []string `type:"list"` // contains filtered or unexported fields }
The Amazon S3 objects that you specify in your event selectors for your trail to log data events. Data events are object-level API operations that access S3 objects, such as GetObject, DeleteObject, and PutObject. You can specify up to 250 S3 buckets and object prefixes for a trail.
Example ¶
You create an event selector for a trail and specify an S3 bucket and an empty prefix, such as arn:aws:s3:::bucket-1/.
You upload an image file to bucket-1.
The PutObject API operation occurs on an object in the S3 bucket that you specified in the event selector. The trail processes and logs the event.
You upload another image file to a different S3 bucket named arn:aws:s3:::bucket-2.
The event occurs on an object in an S3 bucket that you didn't specify in the event selector. The trail doesn’t log the event. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DataResource
func (DataResource) GoString ¶
func (s DataResource) GoString() string
GoString returns the string representation
func (DataResource) String ¶
func (s DataResource) String() string
String returns the string representation
type DeleteTrailInput ¶
type DeleteTrailInput struct { // Specifies the name or the CloudTrail ARN of the trail to be deleted. The // format of a trail ARN is: arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // Name is a required field Name *string `type:"string" required:"true"` // contains filtered or unexported fields }
The request that specifies the name of a trail to delete. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteTrailRequest
func (DeleteTrailInput) GoString ¶
func (s DeleteTrailInput) GoString() string
GoString returns the string representation
func (DeleteTrailInput) String ¶
func (s DeleteTrailInput) String() string
String returns the string representation
func (*DeleteTrailInput) Validate ¶
func (s *DeleteTrailInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTrailOutput ¶
type DeleteTrailOutput struct {
// contains filtered or unexported fields
}
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DeleteTrailResponse
func (DeleteTrailOutput) GoString ¶
func (s DeleteTrailOutput) GoString() string
GoString returns the string representation
func (DeleteTrailOutput) SDKResponseMetadata ¶
func (s DeleteTrailOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteTrailOutput) String ¶
func (s DeleteTrailOutput) String() string
String returns the string representation
type DeleteTrailRequest ¶
type DeleteTrailRequest struct { *aws.Request Input *DeleteTrailInput Copy func(*DeleteTrailInput) DeleteTrailRequest }
DeleteTrailRequest is a API request type for the DeleteTrail API operation.
func (DeleteTrailRequest) Send ¶
func (r DeleteTrailRequest) Send() (*DeleteTrailOutput, error)
Send marshals and sends the DeleteTrail API request.
type DescribeTrailsInput ¶
type DescribeTrailsInput struct { // Specifies whether to include shadow trails in the response. A shadow trail // is the replication in a region of a trail that was created in a different // region. The default is true. IncludeShadowTrails *bool `locationName:"includeShadowTrails" type:"boolean"` // Specifies a list of trail names, trail ARNs, or both, of the trails to describe. // The format of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // If an empty list is specified, information for the trail in the current region // is returned. // // * If an empty list is specified and IncludeShadowTrails is false, then // information for all trails in the current region is returned. // // * If an empty list is specified and IncludeShadowTrails is null or true, // then information for all trails in the current region and any associated // shadow trails in other regions is returned. // // If one or more trail names are specified, information is returned only if // the names match the names of trails belonging only to the current region. // To return information about a trail in another region, you must specify its // trail ARN. TrailNameList []string `locationName:"trailNameList" type:"list"` // contains filtered or unexported fields }
Returns information about the trail. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeTrailsRequest
func (DescribeTrailsInput) GoString ¶
func (s DescribeTrailsInput) GoString() string
GoString returns the string representation
func (DescribeTrailsInput) String ¶
func (s DescribeTrailsInput) String() string
String returns the string representation
type DescribeTrailsOutput ¶
type DescribeTrailsOutput struct { // The list of trail objects. TrailList []Trail `locationName:"trailList" type:"list"` // contains filtered or unexported fields }
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/DescribeTrailsResponse
func (DescribeTrailsOutput) GoString ¶
func (s DescribeTrailsOutput) GoString() string
GoString returns the string representation
func (DescribeTrailsOutput) SDKResponseMetadata ¶
func (s DescribeTrailsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeTrailsOutput) String ¶
func (s DescribeTrailsOutput) String() string
String returns the string representation
type DescribeTrailsRequest ¶
type DescribeTrailsRequest struct { *aws.Request Input *DescribeTrailsInput Copy func(*DescribeTrailsInput) DescribeTrailsRequest }
DescribeTrailsRequest is a API request type for the DescribeTrails API operation.
func (DescribeTrailsRequest) Send ¶
func (r DescribeTrailsRequest) Send() (*DescribeTrailsOutput, error)
Send marshals and sends the DescribeTrails API request.
type Event ¶
type Event struct { // A JSON string that contains a representation of the event returned. CloudTrailEvent *string `type:"string"` // The CloudTrail ID of the event returned. EventId *string `type:"string"` // The name of the event returned. EventName *string `type:"string"` // The AWS service that the request was made to. EventSource *string `type:"string"` // The date and time of the event returned. EventTime *time.Time `type:"timestamp" timestampFormat:"unix"` // A list of resources referenced by the event returned. Resources []Resource `type:"list"` // A user name or role name of the requester that called the API in the event // returned. Username *string `type:"string"` // contains filtered or unexported fields }
Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/Event
type EventSelector ¶
type EventSelector struct { // CloudTrail supports logging only data events for S3 objects. You can specify // up to 250 S3 buckets and object prefixes for a trail. // // For more information, see Data Events (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events) // in the AWS CloudTrail User Guide. DataResources []DataResource `type:"list"` // Specify if you want your event selector to include management events for // your trail. // // For more information, see Management Events (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events) // in the AWS CloudTrail User Guide. // // By default, the value is true. IncludeManagementEvents *bool `type:"boolean"` // 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. ReadWriteType ReadWriteType `type:"string" enum:"true"` // contains filtered or unexported fields }
Use event selectors to specify whether you want your trail to log management and/or 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/EventSelector
func (EventSelector) GoString ¶
func (s EventSelector) GoString() string
GoString returns the string representation
func (EventSelector) String ¶
func (s EventSelector) String() string
String returns the string representation
type GetEventSelectorsInput ¶
type GetEventSelectorsInput struct { // Specifies the name of the trail or trail ARN. If you specify a trail name, // the string 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) // // If you specify a trail ARN, it must be in the format: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // TrailName is a required field TrailName *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventSelectorsRequest
func (GetEventSelectorsInput) GoString ¶
func (s GetEventSelectorsInput) GoString() string
GoString returns the string representation
func (GetEventSelectorsInput) String ¶
func (s GetEventSelectorsInput) String() string
String returns the string representation
func (*GetEventSelectorsInput) Validate ¶
func (s *GetEventSelectorsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetEventSelectorsOutput ¶
type GetEventSelectorsOutput struct { // The event selectors that are configured for the trail. EventSelectors []EventSelector `type:"list"` // The specified trail ARN that has the event selectors. TrailARN *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetEventSelectorsResponse
func (GetEventSelectorsOutput) GoString ¶
func (s GetEventSelectorsOutput) GoString() string
GoString returns the string representation
func (GetEventSelectorsOutput) SDKResponseMetadata ¶
func (s GetEventSelectorsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetEventSelectorsOutput) String ¶
func (s GetEventSelectorsOutput) String() string
String returns the string representation
type GetEventSelectorsRequest ¶
type GetEventSelectorsRequest struct { *aws.Request Input *GetEventSelectorsInput Copy func(*GetEventSelectorsInput) GetEventSelectorsRequest }
GetEventSelectorsRequest is a API request type for the GetEventSelectors API operation.
func (GetEventSelectorsRequest) Send ¶
func (r GetEventSelectorsRequest) Send() (*GetEventSelectorsOutput, error)
Send marshals and sends the GetEventSelectors API request.
type GetTrailStatusInput ¶
type GetTrailStatusInput struct { // Specifies the name or the CloudTrail ARN of the trail for which you are requesting // status. To get the status of a shadow trail (a replication of the trail in // another region), you must specify its ARN. The format of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // Name is a required field Name *string `type:"string" required:"true"` // contains filtered or unexported fields }
The name of a trail about which you want the current status. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrailStatusRequest
func (GetTrailStatusInput) GoString ¶
func (s GetTrailStatusInput) GoString() string
GoString returns the string representation
func (GetTrailStatusInput) String ¶
func (s GetTrailStatusInput) String() string
String returns the string representation
func (*GetTrailStatusInput) Validate ¶
func (s *GetTrailStatusInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetTrailStatusOutput ¶
type GetTrailStatusOutput struct { // Whether the CloudTrail is currently logging AWS API calls. IsLogging *bool `type:"boolean"` // Displays any CloudWatch Logs error that CloudTrail encountered when attempting // to deliver logs to CloudWatch Logs. LatestCloudWatchLogsDeliveryError *string `type:"string"` // Displays the most recent date and time when CloudTrail delivered logs to // CloudWatch Logs. LatestCloudWatchLogsDeliveryTime *time.Time `type:"timestamp" timestampFormat:"unix"` // This field is deprecated. LatestDeliveryAttemptSucceeded *string `type:"string"` // This field is deprecated. LatestDeliveryAttemptTime *string `type:"string"` // Displays any Amazon S3 error that CloudTrail encountered when attempting // to deliver log files to the designated bucket. For more information see the // topic Error Responses (http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html) // in the Amazon S3 API Reference. // // This error occurs only when there is a problem with the destination S3 bucket // and will not occur for timeouts. To resolve the issue, create a new bucket // and call UpdateTrail to specify the new bucket, or fix the existing objects // so that CloudTrail can again write to the bucket. LatestDeliveryError *string `type:"string"` // Specifies the date and time that CloudTrail last delivered log files to an // account's Amazon S3 bucket. LatestDeliveryTime *time.Time `type:"timestamp" timestampFormat:"unix"` // Displays any Amazon S3 error that CloudTrail encountered when attempting // to deliver a digest file to the designated bucket. For more information see // the topic Error Responses (http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html) // in the Amazon S3 API Reference. // // This error occurs only when there is a problem with the destination S3 bucket // and will not occur for timeouts. To resolve the issue, create a new bucket // and call UpdateTrail to specify the new bucket, or fix the existing objects // so that CloudTrail can again write to the bucket. LatestDigestDeliveryError *string `type:"string"` // Specifies the date and time that CloudTrail last delivered a digest file // to an account's Amazon S3 bucket. LatestDigestDeliveryTime *time.Time `type:"timestamp" timestampFormat:"unix"` // This field is deprecated. LatestNotificationAttemptSucceeded *string `type:"string"` // This field is deprecated. LatestNotificationAttemptTime *string `type:"string"` // Displays any Amazon SNS error that CloudTrail encountered when attempting // to send a notification. For more information about Amazon SNS errors, see // the Amazon SNS Developer Guide (http://docs.aws.amazon.com/sns/latest/dg/welcome.html). LatestNotificationError *string `type:"string"` // Specifies the date and time of the most recent Amazon SNS notification that // CloudTrail has written a new log file to an account's Amazon S3 bucket. LatestNotificationTime *time.Time `type:"timestamp" timestampFormat:"unix"` // Specifies the most recent date and time when CloudTrail started recording // API calls for an AWS account. StartLoggingTime *time.Time `type:"timestamp" timestampFormat:"unix"` // Specifies the most recent date and time when CloudTrail stopped recording // API calls for an AWS account. StopLoggingTime *time.Time `type:"timestamp" timestampFormat:"unix"` // This field is deprecated. TimeLoggingStarted *string `type:"string"` // This field is deprecated. TimeLoggingStopped *string `type:"string"` // contains filtered or unexported fields }
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/GetTrailStatusResponse
func (GetTrailStatusOutput) GoString ¶
func (s GetTrailStatusOutput) GoString() string
GoString returns the string representation
func (GetTrailStatusOutput) SDKResponseMetadata ¶
func (s GetTrailStatusOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (GetTrailStatusOutput) String ¶
func (s GetTrailStatusOutput) String() string
String returns the string representation
type GetTrailStatusRequest ¶
type GetTrailStatusRequest struct { *aws.Request Input *GetTrailStatusInput Copy func(*GetTrailStatusInput) GetTrailStatusRequest }
GetTrailStatusRequest is a API request type for the GetTrailStatus API operation.
func (GetTrailStatusRequest) Send ¶
func (r GetTrailStatusRequest) Send() (*GetTrailStatusOutput, error)
Send marshals and sends the GetTrailStatus API request.
type ListPublicKeysInput ¶
type ListPublicKeysInput struct { // Optionally specifies, in UTC, the end of the time range to look up public // keys for CloudTrail digest files. If not specified, the current time is used. EndTime *time.Time `type:"timestamp" timestampFormat:"unix"` // Reserved for future use. NextToken *string `type:"string"` // Optionally specifies, in UTC, the start of the time range to look up public // keys for CloudTrail digest files. If not specified, the current time is used, // and the current public key is returned. StartTime *time.Time `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
Requests the public keys for a specified time range. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListPublicKeysRequest
func (ListPublicKeysInput) GoString ¶
func (s ListPublicKeysInput) GoString() string
GoString returns the string representation
func (ListPublicKeysInput) String ¶
func (s ListPublicKeysInput) String() string
String returns the string representation
type ListPublicKeysOutput ¶
type ListPublicKeysOutput struct { // Reserved for future use. NextToken *string `type:"string"` // Contains an array of PublicKey objects. // // The returned public keys may have validity time ranges that overlap. PublicKeyList []PublicKey `type:"list"` // contains filtered or unexported fields }
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListPublicKeysResponse
func (ListPublicKeysOutput) GoString ¶
func (s ListPublicKeysOutput) GoString() string
GoString returns the string representation
func (ListPublicKeysOutput) SDKResponseMetadata ¶
func (s ListPublicKeysOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListPublicKeysOutput) String ¶
func (s ListPublicKeysOutput) String() string
String returns the string representation
type ListPublicKeysRequest ¶
type ListPublicKeysRequest struct { *aws.Request Input *ListPublicKeysInput Copy func(*ListPublicKeysInput) ListPublicKeysRequest }
ListPublicKeysRequest is a API request type for the ListPublicKeys API operation.
func (ListPublicKeysRequest) Send ¶
func (r ListPublicKeysRequest) Send() (*ListPublicKeysOutput, error)
Send marshals and sends the ListPublicKeys API request.
type ListTagsInput ¶
type ListTagsInput struct { // Reserved for future use. NextToken *string `type:"string"` // Specifies a list of trail ARNs whose tags will be listed. The list has a // limit of 20 ARNs. The format of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // ResourceIdList is a required field ResourceIdList []string `type:"list" required:"true"` // contains filtered or unexported fields }
Specifies a list of trail tags to return. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListTagsRequest
func (ListTagsInput) GoString ¶
func (s ListTagsInput) GoString() string
GoString returns the string representation
func (ListTagsInput) String ¶
func (s ListTagsInput) String() string
String returns the string representation
func (*ListTagsInput) Validate ¶
func (s *ListTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsOutput ¶
type ListTagsOutput struct { // Reserved for future use. NextToken *string `type:"string"` // A list of resource tags. ResourceTagList []ResourceTag `type:"list"` // contains filtered or unexported fields }
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ListTagsResponse
func (ListTagsOutput) GoString ¶
func (s ListTagsOutput) GoString() string
GoString returns the string representation
func (ListTagsOutput) SDKResponseMetadata ¶
func (s ListTagsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListTagsOutput) String ¶
func (s ListTagsOutput) String() string
String returns the string representation
type ListTagsRequest ¶
type ListTagsRequest struct { *aws.Request Input *ListTagsInput Copy func(*ListTagsInput) ListTagsRequest }
ListTagsRequest is a API request type for the ListTags API operation.
func (ListTagsRequest) Send ¶
func (r ListTagsRequest) Send() (*ListTagsOutput, error)
Send marshals and sends the ListTags API request.
type LookupAttribute ¶
type LookupAttribute struct { // Specifies an attribute on which to filter the events returned. // // AttributeKey is a required field AttributeKey LookupAttributeKey `type:"string" required:"true" enum:"true"` // Specifies a value for the specified AttributeKey. // // AttributeValue is a required field AttributeValue *string `type:"string" required:"true"` // contains filtered or unexported fields }
Specifies an attribute and value that filter the events returned. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/LookupAttribute
func (LookupAttribute) GoString ¶
func (s LookupAttribute) GoString() string
GoString returns the string representation
func (LookupAttribute) String ¶
func (s LookupAttribute) String() string
String returns the string representation
func (*LookupAttribute) Validate ¶
func (s *LookupAttribute) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type LookupAttributeKey ¶
type LookupAttributeKey string
const ( LookupAttributeKeyEventId LookupAttributeKey = "EventId" LookupAttributeKeyEventName LookupAttributeKey = "EventName" LookupAttributeKeyUsername LookupAttributeKey = "Username" LookupAttributeKeyResourceType LookupAttributeKey = "ResourceType" LookupAttributeKeyResourceName LookupAttributeKey = "ResourceName" LookupAttributeKeyEventSource LookupAttributeKey = "EventSource" )
Enum values for LookupAttributeKey
func (LookupAttributeKey) MarshalValue ¶
func (enum LookupAttributeKey) MarshalValue() (string, error)
func (LookupAttributeKey) MarshalValueBuf ¶
func (enum LookupAttributeKey) MarshalValueBuf(b []byte) ([]byte, error)
type LookupEventsInput ¶
type LookupEventsInput struct { // Specifies that only events that occur before or at the specified time are // returned. If the specified end time is before the specified start time, an // error is returned. EndTime *time.Time `type:"timestamp" timestampFormat:"unix"` // Contains a list of lookup attributes. Currently the list can contain only // one item. LookupAttributes []LookupAttribute `type:"list"` // The number of events to return. Possible values are 1 through 50. The default // is 10. MaxResults *int64 `min:"1" type:"integer"` // The token to use to get the next page of results after a previous API call. // This token must be passed in with the same parameters that were specified // in the the original call. For example, if the original call specified an // AttributeKey of 'Username' with a value of 'root', the call with NextToken // should include those same parameters. NextToken *string `type:"string"` // Specifies that only events that occur after or at the specified time are // returned. If the specified start time is after the specified end time, an // error is returned. StartTime *time.Time `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
Contains a request for LookupEvents. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/LookupEventsRequest
func (LookupEventsInput) GoString ¶
func (s LookupEventsInput) GoString() string
GoString returns the string representation
func (LookupEventsInput) String ¶
func (s LookupEventsInput) String() string
String returns the string representation
func (*LookupEventsInput) Validate ¶
func (s *LookupEventsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type LookupEventsOutput ¶
type LookupEventsOutput struct { // A list of events returned based on the lookup attributes specified and the // CloudTrail event. The events list is sorted by time. The most recent event // is listed first. Events []Event `type:"list"` // The token to use to get the next page of results after a previous API call. // If the token does not appear, there are no more results to return. The token // must be passed in with the same parameters as the previous call. For example, // if the original call specified an AttributeKey of 'Username' with a value // of 'root', the call with NextToken should include those same parameters. NextToken *string `type:"string"` // contains filtered or unexported fields }
Contains a response to a LookupEvents action. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/LookupEventsResponse
func (LookupEventsOutput) GoString ¶
func (s LookupEventsOutput) GoString() string
GoString returns the string representation
func (LookupEventsOutput) SDKResponseMetadata ¶
func (s LookupEventsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (LookupEventsOutput) String ¶
func (s LookupEventsOutput) String() string
String returns the string representation
type LookupEventsPager ¶
LookupEventsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*LookupEventsPager) CurrentPage ¶
func (p *LookupEventsPager) CurrentPage() *LookupEventsOutput
type LookupEventsRequest ¶
type LookupEventsRequest struct { *aws.Request Input *LookupEventsInput Copy func(*LookupEventsInput) LookupEventsRequest }
LookupEventsRequest is a API request type for the LookupEvents API operation.
func (*LookupEventsRequest) Paginate ¶
func (p *LookupEventsRequest) Paginate(opts ...aws.Option) LookupEventsPager
Paginate pages iterates over the pages of a LookupEventsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a LookupEvents operation. req := client.LookupEventsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (LookupEventsRequest) Send ¶
func (r LookupEventsRequest) Send() (*LookupEventsOutput, error)
Send marshals and sends the LookupEvents API request.
type PublicKey ¶
type PublicKey struct { // The fingerprint of the public key. Fingerprint *string `type:"string"` // The ending time of validity of the public key. ValidityEndTime *time.Time `type:"timestamp" timestampFormat:"unix"` // The starting time of validity of the public key. ValidityStartTime *time.Time `type:"timestamp" timestampFormat:"unix"` // The DER encoded public key value in PKCS#1 format. // // Value is automatically base64 encoded/decoded by the SDK. Value []byte `type:"blob"` // contains filtered or unexported fields }
Contains information about a returned public key. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PublicKey
type PutEventSelectorsInput ¶
type PutEventSelectorsInput struct { // Specifies the settings for your event selectors. You can configure up to // five event selectors for a trail. // // EventSelectors is a required field EventSelectors []EventSelector `type:"list" required:"true"` // Specifies the name of the trail or trail ARN. If you specify a trail name, // the string 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) // // If you specify a trail ARN, it must be in the format: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // TrailName is a required field TrailName *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutEventSelectorsRequest
func (PutEventSelectorsInput) GoString ¶
func (s PutEventSelectorsInput) GoString() string
GoString returns the string representation
func (PutEventSelectorsInput) String ¶
func (s PutEventSelectorsInput) String() string
String returns the string representation
func (*PutEventSelectorsInput) Validate ¶
func (s *PutEventSelectorsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutEventSelectorsOutput ¶
type PutEventSelectorsOutput struct { // Specifies the event selectors configured for your trail. EventSelectors []EventSelector `type:"list"` // Specifies the ARN of the trail that was updated with event selectors. The // format of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail TrailARN *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/PutEventSelectorsResponse
func (PutEventSelectorsOutput) GoString ¶
func (s PutEventSelectorsOutput) GoString() string
GoString returns the string representation
func (PutEventSelectorsOutput) SDKResponseMetadata ¶
func (s PutEventSelectorsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (PutEventSelectorsOutput) String ¶
func (s PutEventSelectorsOutput) String() string
String returns the string representation
type PutEventSelectorsRequest ¶
type PutEventSelectorsRequest struct { *aws.Request Input *PutEventSelectorsInput Copy func(*PutEventSelectorsInput) PutEventSelectorsRequest }
PutEventSelectorsRequest is a API request type for the PutEventSelectors API operation.
func (PutEventSelectorsRequest) Send ¶
func (r PutEventSelectorsRequest) Send() (*PutEventSelectorsOutput, error)
Send marshals and sends the PutEventSelectors API request.
type ReadWriteType ¶
type ReadWriteType string
const ( ReadWriteTypeReadOnly ReadWriteType = "ReadOnly" ReadWriteTypeWriteOnly ReadWriteType = "WriteOnly" ReadWriteTypeAll ReadWriteType = "All" )
Enum values for ReadWriteType
func (ReadWriteType) MarshalValue ¶
func (enum ReadWriteType) MarshalValue() (string, error)
func (ReadWriteType) MarshalValueBuf ¶
func (enum ReadWriteType) MarshalValueBuf(b []byte) ([]byte, error)
type RemoveTagsInput ¶
type RemoveTagsInput struct { // Specifies the ARN of the trail from which tags should be removed. The format // of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // Specifies a list of tags to be removed. TagsList []Tag `type:"list"` // contains filtered or unexported fields }
Specifies the tags to remove from a trail. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RemoveTagsRequest
func (RemoveTagsInput) GoString ¶
func (s RemoveTagsInput) GoString() string
GoString returns the string representation
func (RemoveTagsInput) String ¶
func (s RemoveTagsInput) String() string
String returns the string representation
func (*RemoveTagsInput) Validate ¶
func (s *RemoveTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemoveTagsOutput ¶
type RemoveTagsOutput struct {
// contains filtered or unexported fields
}
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/RemoveTagsResponse
func (RemoveTagsOutput) GoString ¶
func (s RemoveTagsOutput) GoString() string
GoString returns the string representation
func (RemoveTagsOutput) SDKResponseMetadata ¶
func (s RemoveTagsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (RemoveTagsOutput) String ¶
func (s RemoveTagsOutput) String() string
String returns the string representation
type RemoveTagsRequest ¶
type RemoveTagsRequest struct { *aws.Request Input *RemoveTagsInput Copy func(*RemoveTagsInput) RemoveTagsRequest }
RemoveTagsRequest is a API request type for the RemoveTags API operation.
func (RemoveTagsRequest) Send ¶
func (r RemoveTagsRequest) Send() (*RemoveTagsOutput, error)
Send marshals and sends the RemoveTags API request.
type Resource ¶
type Resource struct { // 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. ResourceName *string `type:"string"` // 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 RDS, and AccessKey // for IAM. For a list of resource types supported for event lookup, see Resource // Types Supported for Event Lookup (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/lookup_supported_resourcetypes.html). ResourceType *string `type:"string"` // contains filtered or unexported fields }
Specifies the type and name of a resource referenced by an event. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/Resource
type ResourceTag ¶
type ResourceTag struct { // Specifies the ARN of the resource. ResourceId *string `type:"string"` // A list of tags. TagsList []Tag `type:"list"` // contains filtered or unexported fields }
A resource tag. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/ResourceTag
func (ResourceTag) GoString ¶
func (s ResourceTag) GoString() string
GoString returns the string representation
func (ResourceTag) String ¶
func (s ResourceTag) String() string
String returns the string representation
type StartLoggingInput ¶
type StartLoggingInput struct { // Specifies the name or the CloudTrail ARN of the trail for which CloudTrail // logs AWS API calls. The format of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // Name is a required field Name *string `type:"string" required:"true"` // contains filtered or unexported fields }
The request to CloudTrail to start logging AWS API calls for an account. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartLoggingRequest
func (StartLoggingInput) GoString ¶
func (s StartLoggingInput) GoString() string
GoString returns the string representation
func (StartLoggingInput) String ¶
func (s StartLoggingInput) String() string
String returns the string representation
func (*StartLoggingInput) Validate ¶
func (s *StartLoggingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartLoggingOutput ¶
type StartLoggingOutput struct {
// contains filtered or unexported fields
}
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StartLoggingResponse
func (StartLoggingOutput) GoString ¶
func (s StartLoggingOutput) GoString() string
GoString returns the string representation
func (StartLoggingOutput) SDKResponseMetadata ¶
func (s StartLoggingOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (StartLoggingOutput) String ¶
func (s StartLoggingOutput) String() string
String returns the string representation
type StartLoggingRequest ¶
type StartLoggingRequest struct { *aws.Request Input *StartLoggingInput Copy func(*StartLoggingInput) StartLoggingRequest }
StartLoggingRequest is a API request type for the StartLogging API operation.
func (StartLoggingRequest) Send ¶
func (r StartLoggingRequest) Send() (*StartLoggingOutput, error)
Send marshals and sends the StartLogging API request.
type StopLoggingInput ¶
type StopLoggingInput struct { // Specifies the name or the CloudTrail ARN of the trail for which CloudTrail // will stop logging AWS API calls. The format of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // Name is a required field Name *string `type:"string" required:"true"` // contains filtered or unexported fields }
Passes the request to CloudTrail to stop logging AWS API calls for the specified account. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StopLoggingRequest
func (StopLoggingInput) GoString ¶
func (s StopLoggingInput) GoString() string
GoString returns the string representation
func (StopLoggingInput) String ¶
func (s StopLoggingInput) String() string
String returns the string representation
func (*StopLoggingInput) Validate ¶
func (s *StopLoggingInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopLoggingOutput ¶
type StopLoggingOutput struct {
// contains filtered or unexported fields
}
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/StopLoggingResponse
func (StopLoggingOutput) GoString ¶
func (s StopLoggingOutput) GoString() string
GoString returns the string representation
func (StopLoggingOutput) SDKResponseMetadata ¶
func (s StopLoggingOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (StopLoggingOutput) String ¶
func (s StopLoggingOutput) String() string
String returns the string representation
type StopLoggingRequest ¶
type StopLoggingRequest struct { *aws.Request Input *StopLoggingInput Copy func(*StopLoggingInput) StopLoggingRequest }
StopLoggingRequest is a API request type for the StopLogging API operation.
func (StopLoggingRequest) Send ¶
func (r StopLoggingRequest) Send() (*StopLoggingOutput, error)
Send marshals and sends the StopLogging API request.
type Tag ¶
type Tag struct { // 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. // // Key is a required field Key *string `type:"string" required:"true"` // The value in a key-value pair of a tag. The value must be no longer than // 256 Unicode characters. Value *string `type:"string"` // contains filtered or unexported fields }
A custom key-value pair associated with a resource such as a CloudTrail trail. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/Tag
type Trail ¶
type Trail struct { // Specifies an Amazon Resource Name (ARN), a unique identifier that represents // the log group to which CloudTrail logs will be delivered. CloudWatchLogsLogGroupArn *string `type:"string"` // Specifies the role for the CloudWatch Logs endpoint to assume to write to // a user's log group. CloudWatchLogsRoleArn *string `type:"string"` // Specifies if the trail has custom event selectors. HasCustomEventSelectors *bool `type:"boolean"` // The region in which the trail was created. HomeRegion *string `type:"string"` // Set to True to include AWS API calls from AWS global services such as IAM. // Otherwise, False. IncludeGlobalServiceEvents *bool `type:"boolean"` // Specifies whether the trail belongs only to one region or exists in all regions. IsMultiRegionTrail *bool `type:"boolean"` // 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 KmsKeyId *string `type:"string"` // Specifies whether log file validation is enabled. LogFileValidationEnabled *bool `type:"boolean"` // Name of the trail set by calling CreateTrail. The maximum length is 128 characters. Name *string `type:"string"` // Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. // See Amazon S3 Bucket Naming Requirements (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). S3BucketName *string `type:"string"` // 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 (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html).The // maximum length is 200 characters. S3KeyPrefix *string `type:"string"` // 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 SnsTopicARN *string `type:"string"` // This field is deprecated. Use SnsTopicARN. SnsTopicName *string `deprecated:"true" type:"string"` // Specifies the ARN of the trail. The format of a trail ARN is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail TrailARN *string `type:"string"` // contains filtered or unexported fields }
The settings for a trail. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/Trail
type UpdateTrailInput ¶
type UpdateTrailInput struct { // 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. CloudWatchLogsLogGroupArn *string `type:"string"` // Specifies the role for the CloudWatch Logs endpoint to assume to write to // a user's log group. CloudWatchLogsRoleArn *string `type:"string"` // Specifies whether log file validation is enabled. The default is false. // // When you disable log file integrity validation, the chain of digest files // is broken after one hour. CloudTrail will not create digest files for log // files that were delivered during a period in which log file integrity validation // was disabled. For example, if you enable log file integrity validation at // noon on January 1, disable it at noon on January 2, and re-enable it at noon // on January 10, digest files will not be created for the log files delivered // from noon on January 2 to noon on January 10. The same applies whenever you // stop CloudTrail logging or delete a trail. EnableLogFileValidation *bool `type:"boolean"` // Specifies whether the trail is publishing events from global services such // as IAM to the log files. IncludeGlobalServiceEvents *bool `type:"boolean"` // Specifies whether the trail applies only to the current region or to all // regions. The default is false. If the trail exists only in the current region // and this value is set to true, shadow trails (replications of the trail) // will be created in the other regions. If the trail exists in all regions // and this value is set to false, the trail will remain in the region where // it was created, and its shadow trails in other regions will be deleted. IsMultiRegionTrail *bool `type:"boolean"` // 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: // // * alias/MyAliasName // // * arn:aws:kms:us-east-1:123456789012:alias/MyAliasName // // * arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012 // // * 12345678-1234-1234-1234-123456789012 KmsKeyId *string `type:"string"` // Specifies the name of the trail or trail ARN. If Name is a trail name, the // string 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) // // If Name is a trail ARN, it must be in the format: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail // // Name is a required field Name *string `type:"string" required:"true"` // Specifies the name of the Amazon S3 bucket designated for publishing log // files. See Amazon S3 Bucket Naming Requirements (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html). S3BucketName *string `type:"string"` // 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 (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). // The maximum length is 200 characters. S3KeyPrefix *string `type:"string"` // Specifies the name of the Amazon SNS topic defined for notification of log // file delivery. The maximum length is 256 characters. SnsTopicName *string `type:"string"` // contains filtered or unexported fields }
Specifies settings to update for the trail. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateTrailRequest
func (UpdateTrailInput) GoString ¶
func (s UpdateTrailInput) GoString() string
GoString returns the string representation
func (UpdateTrailInput) String ¶
func (s UpdateTrailInput) String() string
String returns the string representation
func (*UpdateTrailInput) Validate ¶
func (s *UpdateTrailInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateTrailOutput ¶
type UpdateTrailOutput struct { // Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail // logs will be delivered. CloudWatchLogsLogGroupArn *string `type:"string"` // Specifies the role for the CloudWatch Logs endpoint to assume to write to // a user's log group. CloudWatchLogsRoleArn *string `type:"string"` // Specifies whether the trail is publishing events from global services such // as IAM to the log files. IncludeGlobalServiceEvents *bool `type:"boolean"` // Specifies whether the trail exists in one region or in all regions. IsMultiRegionTrail *bool `type:"boolean"` // 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 KmsKeyId *string `type:"string"` // Specifies whether log file integrity validation is enabled. LogFileValidationEnabled *bool `type:"boolean"` // Specifies the name of the trail. Name *string `type:"string"` // Specifies the name of the Amazon S3 bucket designated for publishing log // files. S3BucketName *string `type:"string"` // 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 (http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html). S3KeyPrefix *string `type:"string"` // 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 SnsTopicARN *string `type:"string"` // This field is deprecated. Use SnsTopicARN. SnsTopicName *string `deprecated:"true" type:"string"` // Specifies the ARN of the trail that was updated. The format of a trail ARN // is: // // arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail TrailARN *string `type:"string"` // contains filtered or unexported fields }
Returns the objects or data listed below if successful. Otherwise, returns an error. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudtrail-2013-11-01/UpdateTrailResponse
func (UpdateTrailOutput) GoString ¶
func (s UpdateTrailOutput) GoString() string
GoString returns the string representation
func (UpdateTrailOutput) SDKResponseMetadata ¶
func (s UpdateTrailOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateTrailOutput) String ¶
func (s UpdateTrailOutput) String() string
String returns the string representation
type UpdateTrailRequest ¶
type UpdateTrailRequest struct { *aws.Request Input *UpdateTrailInput Copy func(*UpdateTrailInput) UpdateTrailRequest }
UpdateTrailRequest is a API request type for the UpdateTrail API operation.
func (UpdateTrailRequest) Send ¶
func (r UpdateTrailRequest) Send() (*UpdateTrailOutput, error)
Send marshals and sends the UpdateTrail API request.
Directories ¶
Path | Synopsis |
---|---|
Package cloudtrailiface provides an interface to enable mocking the AWS CloudTrail service client for testing your code.
|
Package cloudtrailiface provides an interface to enable mocking the AWS CloudTrail service client for testing your code. |