Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnFlowLogPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnFlowLogPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFlowLogPropsMixin>

Enclosing class:

CfnFlowLogPropsMixin

@Stability(Stable)
public static final class CfnFlowLogPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnFlowLogPropsMixin>

A fluent builder for CfnFlowLogPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnFlowLogPropsMixin	build()
static CfnFlowLogPropsMixin.Builder	create()
static CfnFlowLogPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnFlowLogPropsMixin.Builder	deliverCrossAccountRole(String deliverCrossAccountRole)	The ARN of the IAM role that allows the service to publish flow logs across accounts.
CfnFlowLogPropsMixin.Builder	deliverLogsPermissionArn(String deliverLogsPermissionArn)	The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.
CfnFlowLogPropsMixin.Builder	deliverLogsPermissionArn(IRoleRef deliverLogsPermissionArn)	The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.
CfnFlowLogPropsMixin.Builder	destinationOptions(Object destinationOptions)	The destination options.
CfnFlowLogPropsMixin.Builder	logDestination(String logDestination)	The destination for the flow log data.
CfnFlowLogPropsMixin.Builder	logDestination(ILogGroupRef logDestination)	The destination for the flow log data.
CfnFlowLogPropsMixin.Builder	logDestination(IBucketRef logDestination)	The destination for the flow log data.
CfnFlowLogPropsMixin.Builder	logDestinationType(String logDestinationType)	The type of destination for the flow log data.
CfnFlowLogPropsMixin.Builder	logFormat(String logFormat)	The fields to include in the flow log record, in the order in which they should appear.
CfnFlowLogPropsMixin.Builder	logGroupName(String logGroupName)	The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
CfnFlowLogPropsMixin.Builder	logGroupName(ILogGroupRef logGroupName)	The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
CfnFlowLogPropsMixin.Builder	maxAggregationInterval(Number maxAggregationInterval)	The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.
CfnFlowLogPropsMixin.Builder	resourceId(String resourceId)	The ID of the resource to monitor.
CfnFlowLogPropsMixin.Builder	resourceId(ISubnetRef resourceId)	The ID of the resource to monitor.
CfnFlowLogPropsMixin.Builder	resourceId(ITransitGatewayRef resourceId)	The ID of the resource to monitor.
CfnFlowLogPropsMixin.Builder	resourceId(IVPCRef resourceId)	The ID of the resource to monitor.
CfnFlowLogPropsMixin.Builder	resourceType(String resourceType)	The type of resource to monitor.
CfnFlowLogPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The tags to apply to the flow logs.
CfnFlowLogPropsMixin.Builder	trafficType(String trafficType)	The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnFlowLogPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnFlowLogPropsMixin.Builder.

create

@Stability(Stable)
public static CfnFlowLogPropsMixin.Builder create()

Returns:

a new instance of CfnFlowLogPropsMixin.Builder.

deliverCrossAccountRole

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder deliverCrossAccountRole(String deliverCrossAccountRole)

The ARN of the IAM role that allows the service to publish flow logs across accounts.

Parameters:

deliverCrossAccountRole - The ARN of the IAM role that allows the service to publish flow logs across accounts. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-delivercrossaccountrole

deliverLogsPermissionArn

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder deliverLogsPermissionArn(String deliverLogsPermissionArn)

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

This parameter is required if the destination type is cloud-watch-logs , or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

Parameters:

deliverLogsPermissionArn - The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn

deliverLogsPermissionArn

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder deliverLogsPermissionArn(IRoleRef deliverLogsPermissionArn)

The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination.

This parameter is required if the destination type is cloud-watch-logs , or if the destination type is kinesis-data-firehose and the delivery stream and the resources to monitor are in different accounts.

Parameters:

deliverLogsPermissionArn - The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-deliverlogspermissionarn

destinationOptions

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder destinationOptions(Object destinationOptions)

The destination options.

Parameters:

destinationOptions - The destination options. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-destinationoptions

logDestination

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder logDestination(String logDestination)

The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs , specify the ARN of a CloudWatch Logs log group. For example:

arn:aws:logs: region : account_id :log-group: my_group

Alternatively, use the LogGroupName parameter.

• If the destination type is s3 , specify the ARN of an S3 bucket. For example:

arn:aws:s3::: my_bucket / my_subfolder /

The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose , specify the ARN of a Kinesis Data Firehose delivery stream. For example:

arn:aws:firehose: region : account_id :deliverystream: my_stream

Parameters:

logDestination - The destination for the flow log data. The meaning of this parameter depends on the destination type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination

logDestination

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder logDestination(ILogGroupRef logDestination)

The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs , specify the ARN of a CloudWatch Logs log group. For example:

arn:aws:logs: region : account_id :log-group: my_group

Alternatively, use the LogGroupName parameter.

• If the destination type is s3 , specify the ARN of an S3 bucket. For example:

arn:aws:s3::: my_bucket / my_subfolder /

The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose , specify the ARN of a Kinesis Data Firehose delivery stream. For example:

arn:aws:firehose: region : account_id :deliverystream: my_stream

Parameters:

logDestination - The destination for the flow log data. The meaning of this parameter depends on the destination type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination

logDestination

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder logDestination(IBucketRef logDestination)

The destination for the flow log data. The meaning of this parameter depends on the destination type.

• If the destination type is cloud-watch-logs , specify the ARN of a CloudWatch Logs log group. For example:

arn:aws:logs: region : account_id :log-group: my_group

Alternatively, use the LogGroupName parameter.

• If the destination type is s3 , specify the ARN of an S3 bucket. For example:

arn:aws:s3::: my_bucket / my_subfolder /

The subfolder is optional. Note that you can't use AWSLogs as a subfolder name.

• If the destination type is kinesis-data-firehose , specify the ARN of a Kinesis Data Firehose delivery stream. For example:

arn:aws:firehose: region : account_id :deliverystream: my_stream

Parameters:

logDestination - The destination for the flow log data. The meaning of this parameter depends on the destination type. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestination

logDestinationType

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder logDestinationType(String logDestinationType)

The type of destination for the flow log data.

Default: cloud-watch-logs

Parameters:

logDestinationType - The type of destination for the flow log data. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logdestinationtype

logFormat

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder logFormat(String logFormat)

The fields to include in the flow log record, in the order in which they should appear.

If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see Flow log records in the Amazon VPC User Guide or Transit Gateway Flow Log records in the AWS Transit Gateway Guide .

Specify the fields using the ${field-id} format, separated by spaces.

Parameters:

logFormat - The fields to include in the flow log record, in the order in which they should appear. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-logformat

logGroupName

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder logGroupName(String logGroupName)

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs .

Parameters:

logGroupName - The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname

logGroupName

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder logGroupName(ILogGroupRef logGroupName)

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

This parameter is valid only if the destination type is cloud-watch-logs .

Parameters:

logGroupName - The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-loggroupname

maxAggregationInterval

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder maxAggregationInterval(Number maxAggregationInterval)

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record.

The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types.

When a network interface is attached to a Nitro-based instance , the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

Parameters:

maxAggregationInterval - The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-maxaggregationinterval

resourceId

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder resourceId(String resourceId)

The ID of the resource to monitor.

For example, if the resource type is VPC , specify the ID of the VPC.

Parameters:

resourceId - The ID of the resource to monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid

resourceId

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder resourceId(ISubnetRef resourceId)

The ID of the resource to monitor.

For example, if the resource type is VPC , specify the ID of the VPC.

Parameters:

resourceId - The ID of the resource to monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid

resourceId

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder resourceId(ITransitGatewayRef resourceId)

The ID of the resource to monitor.

For example, if the resource type is VPC , specify the ID of the VPC.

Parameters:

resourceId - The ID of the resource to monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid

resourceId

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder resourceId(IVPCRef resourceId)

The ID of the resource to monitor.

For example, if the resource type is VPC , specify the ID of the VPC.

Parameters:

resourceId - The ID of the resource to monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourceid

resourceType

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder resourceType(String resourceType)

The type of resource to monitor.

Parameters:

resourceType - The type of resource to monitor. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-resourcetype

tags

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder tags(List<? extends CfnTag> tags)

The tags to apply to the flow logs.

Parameters:

tags - The tags to apply to the flow logs. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-tags

trafficType

@Stability(Stable)
public CfnFlowLogPropsMixin.Builder trafficType(String trafficType)

The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic).

This parameter is not supported for transit gateway resource types. It is required for the other resource types.

Parameters:

trafficType - The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-flowlog.html#cfn-ec2-flowlog-traffictype

build

@Stability(Stable)
public CfnFlowLogPropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnFlowLogPropsMixin>

Returns:

a newly built instance of CfnFlowLogPropsMixin.