Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

UpdateAcceleratorAttributes

Update the attributes for an accelerator.

Request Syntax


{
   "AcceleratorArn": "string",
   "FlowLogsEnabled": boolean,
   "FlowLogsS3Bucket": "string",
   "FlowLogsS3Prefix": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AcceleratorArn

The Amazon Resource Name (ARN) of the accelerator that you want to update.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

FlowLogsEnabled

Update whether flow logs are enabled. The default value is false. If the value is true, FlowLogsS3Bucket and FlowLogsS3Prefix must be specified.

For more information, see Flow Logs in the AWS Global Accelerator Developer Guide.

Type: Boolean

Required: No

FlowLogsS3Bucket

The name of the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true. The bucket must exist and have a bucket policy that grants AWS Global Accelerator permission to write to the bucket.

Type: String

Length Constraints: Maximum length of 255.

Required: No

FlowLogsS3Prefix

Update the prefix for the location in the Amazon S3 bucket for the flow logs. Attribute is required if FlowLogsEnabled is true.

If you specify slash (/) for the S3 bucket prefix, the log file bucket folder structure will include a double slash (//), like the following:

s3-bucket_name//AWSLogs/aws_account_id

Type: String

Length Constraints: Maximum length of 255.

Required: No

Response Syntax


{
   "AcceleratorAttributes": { 
      "FlowLogsEnabled": boolean,
      "FlowLogsS3Bucket": "string",
      "FlowLogsS3Prefix": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AcceleratorAttributes

Updated attributes for the accelerator.

Type: AcceleratorAttributes object

Errors

For information about the errors that are common to all actions, see Common Errors.

AcceleratorNotFoundException

The accelerator that you specified doesn't exist.

HTTP Status Code: 400

AccessDeniedException

You don't have access permission.

HTTP Status Code: 400

InternalServiceErrorException

There was an internal error for AWS Global Accelerator.

HTTP Status Code: 400

InvalidArgumentException

An argument that you specified is invalid.

HTTP Status Code: 400

Examples

Update attributes for an accelerator

The following is an example for updating an accelerator to enable flow logs.


aws globalaccelerator update-accelerator-attributes 
       --accelerator-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh 
       --flow-logs-enabled 
       --flow-logs-s3-bucket flowlogs-abc 
       --flow-logs-s3-prefix bucketprefix-abc
       --region us-west-2


{
    "AcceleratorAttributes": {
        "FlowLogsEnabled": true
        "FlowLogsS3Bucket": flowlogs-abc
        "FlowLogsS3Prefix": bucketprefix-abc
    }
}