updateTrail method

Future<UpdateTrailResponse> updateTrail({ required String name, String? cloudWatchLogsLogGroupArn, String? cloudWatchLogsRoleArn, bool? enableLogFileValidation, bool? includeGlobalServiceEvents, bool? isMultiRegionTrail, bool? isOrganizationTrail, String? kmsKeyId, String? s3BucketName, String? s3KeyPrefix, String? snsTopicName, })

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.

May throw S3BucketDoesNotExistException. May throw InsufficientS3BucketPolicyException. May throw InsufficientSnsTopicPolicyException. May throw InsufficientEncryptionPolicyException. May throw TrailNotFoundException. May throw InvalidS3BucketNameException. May throw InvalidS3PrefixException. May throw InvalidSnsTopicNameException. May throw InvalidKmsKeyIdException. May throw InvalidTrailNameException. May throw TrailNotProvidedException. May throw InvalidEventSelectorsException. May throw InvalidParameterCombinationException. May throw InvalidHomeRegionException. May throw KmsKeyNotFoundException. May throw KmsKeyDisabledException. May throw KmsException. May throw InvalidCloudWatchLogsLogGroupArnException. May throw InvalidCloudWatchLogsRoleArnException. May throw CloudWatchLogsDeliveryUnavailableException. May throw UnsupportedOperationException. May throw OperationNotPermittedException. May throw CloudTrailAccessNotEnabledException. May throw InsufficientDependencyServiceAccessPermissionException. May throw OrganizationsNotInUseException. May throw NotOrganizationMasterAccountException. May throw OrganizationNotInAllFeaturesModeException. May throw CloudTrailInvalidClientTokenIdException.

Parameter name : 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-2:123456789012:trail/MyTrail

Parameter cloudWatchLogsLogGroupArn : 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.

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

Parameter enableLogFileValidation : Specifies whether log file validation is enabled. The default is false.

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

Parameter isMultiRegionTrail : 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. As a best practice, consider using trails that log events in all regions.

Parameter isOrganizationTrail : Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current AWS account but be deleted from all member accounts in the organization.

Parameter kmsKeyId : 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-2:123456789012:alias/MyAliasName
• arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012
• 12345678-1234-1234-1234-123456789012

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

Parameter s3KeyPrefix : Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

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

Implementation

Future<UpdateTrailResponse> updateTrail({
  required String name,
  String? cloudWatchLogsLogGroupArn,
  String? cloudWatchLogsRoleArn,
  bool? enableLogFileValidation,
  bool? includeGlobalServiceEvents,
  bool? isMultiRegionTrail,
  bool? isOrganizationTrail,
  String? kmsKeyId,
  String? s3BucketName,
  String? s3KeyPrefix,
  String? snsTopicName,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101.UpdateTrail'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Name': name,
      if (cloudWatchLogsLogGroupArn != null)
        'CloudWatchLogsLogGroupArn': cloudWatchLogsLogGroupArn,
      if (cloudWatchLogsRoleArn != null)
        'CloudWatchLogsRoleArn': cloudWatchLogsRoleArn,
      if (enableLogFileValidation != null)
        'EnableLogFileValidation': enableLogFileValidation,
      if (includeGlobalServiceEvents != null)
        'IncludeGlobalServiceEvents': includeGlobalServiceEvents,
      if (isMultiRegionTrail != null)
        'IsMultiRegionTrail': isMultiRegionTrail,
      if (isOrganizationTrail != null)
        'IsOrganizationTrail': isOrganizationTrail,
      if (kmsKeyId != null) 'KmsKeyId': kmsKeyId,
      if (s3BucketName != null) 'S3BucketName': s3BucketName,
      if (s3KeyPrefix != null) 'S3KeyPrefix': s3KeyPrefix,
      if (snsTopicName != null) 'SnsTopicName': snsTopicName,
    },
  );

  return UpdateTrailResponse.fromJson(jsonResponse.body);
}