Class FlowLogDestinationConfig

Flow Log Destination configuration.

Inheritance

object

FlowLogDestinationConfig

Implements

IFlowLogDestinationConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.EC2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class FlowLogDestinationConfig : IFlowLogDestinationConfig

Syntax (vb)

Public Class FlowLogDestinationConfig Implements IFlowLogDestinationConfig

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.AWS.Logs;
            using Amazon.CDK.AWS.S3;

            Bucket bucket;
            LogGroup logGroup;
            Role role;

            var flowLogDestinationConfig = new FlowLogDestinationConfig {
                LogDestinationType = FlowLogDestinationType.CLOUD_WATCH_LOGS,

                // the properties below are optional
                DeliveryStreamArn = "deliveryStreamArn",
                DestinationOptions = new DestinationOptions {
                    FileFormat = FlowLogFileFormat.PLAIN_TEXT,
                    HiveCompatiblePartitions = false,
                    PerHourPartition = false
                },
                IamRole = role,
                KeyPrefix = "keyPrefix",
                LogGroup = logGroup,
                S3Bucket = bucket
            };

Synopsis

Constructors

FlowLogDestinationConfig()

Flow Log Destination configuration.

Properties

DeliveryStreamArn	The ARN of Amazon Data Firehose delivery stream to publish the flow logs to.
DestinationOptions	Options for writing flow logs to a supported destination.
IamRole	The IAM Role that has access to publish to CloudWatch logs.
KeyPrefix	S3 bucket key prefix to publish the flow logs to.
LogDestinationType	The type of destination to publish the flow logs to.
LogGroup	The CloudWatch Logs Log Group to publish the flow logs to.
S3Bucket	S3 bucket to publish the flow logs to.

Constructors

FlowLogDestinationConfig()

Flow Log Destination configuration.

public FlowLogDestinationConfig()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.AWS.Logs;
            using Amazon.CDK.AWS.S3;

            Bucket bucket;
            LogGroup logGroup;
            Role role;

            var flowLogDestinationConfig = new FlowLogDestinationConfig {
                LogDestinationType = FlowLogDestinationType.CLOUD_WATCH_LOGS,

                // the properties below are optional
                DeliveryStreamArn = "deliveryStreamArn",
                DestinationOptions = new DestinationOptions {
                    FileFormat = FlowLogFileFormat.PLAIN_TEXT,
                    HiveCompatiblePartitions = false,
                    PerHourPartition = false
                },
                IamRole = role,
                KeyPrefix = "keyPrefix",
                LogGroup = logGroup,
                S3Bucket = bucket
            };

Properties

DeliveryStreamArn

The ARN of Amazon Data Firehose delivery stream to publish the flow logs to.

public string? DeliveryStreamArn { get; set; }

Property Value

string

Remarks

Default: - undefined

DestinationOptions

Options for writing flow logs to a supported destination.

public IDestinationOptions? DestinationOptions { get; set; }

Property Value

IDestinationOptions

Remarks

Default: - undefined

IamRole

The IAM Role that has access to publish to CloudWatch logs.

public IRole? IamRole { get; set; }

Property Value

IRole

Remarks

Default: - default IAM role is created for you

KeyPrefix

S3 bucket key prefix to publish the flow logs to.

public string? KeyPrefix { get; set; }

Property Value

string

Remarks

Default: - undefined

LogDestinationType

The type of destination to publish the flow logs to.

public FlowLogDestinationType LogDestinationType { get; set; }

Property Value

FlowLogDestinationType

Remarks

Default: - CLOUD_WATCH_LOGS

LogGroup

The CloudWatch Logs Log Group to publish the flow logs to.

public ILogGroup? LogGroup { get; set; }

Property Value

ILogGroup

Remarks

Default: - default log group is created for you

S3Bucket

S3 bucket to publish the flow logs to.

public IBucket? S3Bucket { get; set; }

Property Value

IBucket

Remarks

Default: - undefined

Implements

IFlowLogDestinationConfig