Skip to content

Latest commit

 

History

History
331 lines (193 loc) · 11 KB

README.md

File metadata and controls

331 lines (193 loc) · 11 KB

Fastly::Logging::S3

Manage a Fastly service

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "Fastly::Logging::S3",
    "Properties" : {
        "AccessKey" : String,
        "Acl" : String,
        "BucketName" : String,
        "CompressionCodec" : String,
        "Domain" : String,
        "Format" : String,
        "FormatVersion" : Integer,
        "GzipLevel" : Integer,
        "IamRole" : String,
        "MessageType" : String,
        "Name" : String,
        "Path" : String,
        "Period" : Integer,
        "Placement" : String,
        "PublicKey" : String,
        "Redundancy" : String,
        "ResponseCondition" : String,
        "SecretKey" : String,
        "ServerSideEncryption" : String,
        "ServerSideEncryptionKmsKeyId" : String,
        "ServiceId" : String,
        "VersionId" : Double,
        "Version" : String
    }
}

YAML

Type: Fastly::Logging::S3
Properties:
    AccessKey: String
    Acl: String
    BucketName: String
    CompressionCodec: String
    Domain: String
    Format: String
    FormatVersion: Integer
    GzipLevel: Integer
    IamRole: String
    MessageType: String
    Name: String
    Path: String
    Period: Integer
    Placement: String
    PublicKey: String
    Redundancy: String
    ResponseCondition: String
    SecretKey: String
    ServerSideEncryption: String
    ServerSideEncryptionKmsKeyId: String
    ServiceId: String
    VersionId: Double
    Version: String

Properties

AccessKey

The access key for your S3 account. Not required if iam_role is provided.

Required: No

Type: String

Update requires: No interruption

Acl

The access control list (ACL) specific request header

Required: No

Type: String

Update requires: No interruption

BucketName

The bucket name for S3 account.

Required: Yes

Type: String

Update requires: No interruption

CompressionCodec

The codec used for compressing your logs.

Required: No

Type: String

Allowed Values: zstd | snappy | gzip

Update requires: No interruption

Domain

The domain of the Amazon S3 endpoint.

Required: No

Type: String

Update requires: No interruption

Format

A Fastly log format string.

Required: No

Type: String

Update requires: No interruption

FormatVersion

The version of the custom logging format used for the configured endpoint.

Required: No

Type: Integer

Allowed Values: 1 | 2

Update requires: No interruption

GzipLevel

The level of gzip encoding when sending logs (default 0, no compression).

Required: No

Type: Integer

Update requires: No interruption

IamRole

The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3. Not required if access_key and secret_key are provided.

Required: No

Type: String

Update requires: No interruption

MessageType

How the message should be formatted. [Default classic]

Required: No

Type: String

Allowed Values: classic | loggly | logplex | blank

Update requires: No interruption

Name

The name for the real-time logging configuration.

Required: No

Type: String

Update requires: Replacement

Path

The path to upload logs to.

Required: No

Type: String

Update requires: No interruption

Period

How frequently log files are finalized so they can be available for reading (in seconds).

Required: No

Type: Integer

Update requires: No interruption

Placement

Where in the generated VCL the logging call should be placed.

Required: No

Type: String

Allowed Values: none | waf_debug

Update requires: No interruption

PublicKey

A PGP public key that Fastly will use to encrypt your log files before writing them to disk.

Required: No

Type: String

Update requires: No interruption

Redundancy

The S3 redundancy level

Required: No

Type: String

Update requires: No interruption

ResponseCondition

The name of an existing condition in the configured endpoint, or leave blank to always execute.

Required: No

Type: String

Update requires: No interruption

SecretKey

The secret key for your S3 account. Not required if iam_role is provided.

Required: No

Type: String

Update requires: No interruption

ServerSideEncryption

Set this to AES256 or aws:kms to enable S3 Server Side Encryption.

Required: No

Type: String

Update requires: No interruption

ServerSideEncryptionKmsKeyId

Optional server-side KMS Key Id. Must be set if server_side_encryption is set to aws:kms or AES256.

Required: No

Type: String

Update requires: No interruption

ServiceId

Alphanumeric string identifying the service. Read-only.

Required: No

Type: String

Update requires: Replacement

VersionId

Id identifying the service version.

Required: No

Type: Double

Update requires: Replacement

Version

Integer identifying a domain version. Read-only.

Required: No

Type: String

Update requires: No interruption

Return Values

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

Date and time in ISO 8601 format. Read-only.

DeletedAt

Date and time in ISO 8601 format. Read-only.

UpdatedAt

Date and time in ISO 8601 format. Read-only.