AWS SDK for C++  1.7.230
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::EC2::Model::CreateFlowLogsRequest Class Reference

#include <CreateFlowLogsRequest.h>

+ Inheritance diagram for Aws::EC2::Model::CreateFlowLogsRequest:

Public Member Functions

 CreateFlowLogsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
CreateFlowLogsRequestWithDryRun (bool value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
CreateFlowLogsRequestWithClientToken (const Aws::String &value)
 
CreateFlowLogsRequestWithClientToken (Aws::String &&value)
 
CreateFlowLogsRequestWithClientToken (const char *value)
 
const Aws::StringGetDeliverLogsPermissionArn () const
 
bool DeliverLogsPermissionArnHasBeenSet () const
 
void SetDeliverLogsPermissionArn (const Aws::String &value)
 
void SetDeliverLogsPermissionArn (Aws::String &&value)
 
void SetDeliverLogsPermissionArn (const char *value)
 
CreateFlowLogsRequestWithDeliverLogsPermissionArn (const Aws::String &value)
 
CreateFlowLogsRequestWithDeliverLogsPermissionArn (Aws::String &&value)
 
CreateFlowLogsRequestWithDeliverLogsPermissionArn (const char *value)
 
const Aws::StringGetLogGroupName () const
 
bool LogGroupNameHasBeenSet () const
 
void SetLogGroupName (const Aws::String &value)
 
void SetLogGroupName (Aws::String &&value)
 
void SetLogGroupName (const char *value)
 
CreateFlowLogsRequestWithLogGroupName (const Aws::String &value)
 
CreateFlowLogsRequestWithLogGroupName (Aws::String &&value)
 
CreateFlowLogsRequestWithLogGroupName (const char *value)
 
const Aws::Vector< Aws::String > & GetResourceIds () const
 
bool ResourceIdsHasBeenSet () const
 
void SetResourceIds (const Aws::Vector< Aws::String > &value)
 
void SetResourceIds (Aws::Vector< Aws::String > &&value)
 
CreateFlowLogsRequestWithResourceIds (const Aws::Vector< Aws::String > &value)
 
CreateFlowLogsRequestWithResourceIds (Aws::Vector< Aws::String > &&value)
 
CreateFlowLogsRequestAddResourceIds (const Aws::String &value)
 
CreateFlowLogsRequestAddResourceIds (Aws::String &&value)
 
CreateFlowLogsRequestAddResourceIds (const char *value)
 
const FlowLogsResourceTypeGetResourceType () const
 
bool ResourceTypeHasBeenSet () const
 
void SetResourceType (const FlowLogsResourceType &value)
 
void SetResourceType (FlowLogsResourceType &&value)
 
CreateFlowLogsRequestWithResourceType (const FlowLogsResourceType &value)
 
CreateFlowLogsRequestWithResourceType (FlowLogsResourceType &&value)
 
const TrafficTypeGetTrafficType () const
 
bool TrafficTypeHasBeenSet () const
 
void SetTrafficType (const TrafficType &value)
 
void SetTrafficType (TrafficType &&value)
 
CreateFlowLogsRequestWithTrafficType (const TrafficType &value)
 
CreateFlowLogsRequestWithTrafficType (TrafficType &&value)
 
const LogDestinationTypeGetLogDestinationType () const
 
bool LogDestinationTypeHasBeenSet () const
 
void SetLogDestinationType (const LogDestinationType &value)
 
void SetLogDestinationType (LogDestinationType &&value)
 
CreateFlowLogsRequestWithLogDestinationType (const LogDestinationType &value)
 
CreateFlowLogsRequestWithLogDestinationType (LogDestinationType &&value)
 
const Aws::StringGetLogDestination () const
 
bool LogDestinationHasBeenSet () const
 
void SetLogDestination (const Aws::String &value)
 
void SetLogDestination (Aws::String &&value)
 
void SetLogDestination (const char *value)
 
CreateFlowLogsRequestWithLogDestination (const Aws::String &value)
 
CreateFlowLogsRequestWithLogDestination (Aws::String &&value)
 
CreateFlowLogsRequestWithLogDestination (const char *value)
 
const Aws::StringGetLogFormat () const
 
bool LogFormatHasBeenSet () const
 
void SetLogFormat (const Aws::String &value)
 
void SetLogFormat (Aws::String &&value)
 
void SetLogFormat (const char *value)
 
CreateFlowLogsRequestWithLogFormat (const Aws::String &value)
 
CreateFlowLogsRequestWithLogFormat (Aws::String &&value)
 
CreateFlowLogsRequestWithLogFormat (const char *value)
 
- Public Member Functions inherited from Aws::EC2::EC2Request
virtual ~EC2Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::EC2::EC2Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 35 of file CreateFlowLogsRequest.h.

Constructor & Destructor Documentation

◆ CreateFlowLogsRequest()

Aws::EC2::Model::CreateFlowLogsRequest::CreateFlowLogsRequest ( )

Member Function Documentation

◆ AddResourceIds() [1/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::AddResourceIds ( const Aws::String value)
inline

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Definition at line 321 of file CreateFlowLogsRequest.h.

◆ AddResourceIds() [2/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::AddResourceIds ( Aws::String &&  value)
inline

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Definition at line 327 of file CreateFlowLogsRequest.h.

◆ AddResourceIds() [3/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::AddResourceIds ( const char *  value)
inline

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Definition at line 333 of file CreateFlowLogsRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::ClientTokenHasBeenSet ( ) const
inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Definition at line 100 of file CreateFlowLogsRequest.h.

◆ DeliverLogsPermissionArnHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::DeliverLogsPermissionArnHasBeenSet ( ) const
inline

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 165 of file CreateFlowLogsRequest.h.

◆ DryRunHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::DryRunHasBeenSet ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 67 of file CreateFlowLogsRequest.h.

◆ DumpBodyToUrl()

void Aws::EC2::Model::CreateFlowLogsRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetClientToken()

const Aws::String& Aws::EC2::Model::CreateFlowLogsRequest::GetClientToken ( ) const
inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Definition at line 92 of file CreateFlowLogsRequest.h.

◆ GetDeliverLogsPermissionArn()

const Aws::String& Aws::EC2::Model::CreateFlowLogsRequest::GetDeliverLogsPermissionArn ( ) const
inline

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 157 of file CreateFlowLogsRequest.h.

◆ GetDryRun()

bool Aws::EC2::Model::CreateFlowLogsRequest::GetDryRun ( ) const
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 59 of file CreateFlowLogsRequest.h.

◆ GetLogDestination()

const Aws::String& Aws::EC2::Model::CreateFlowLogsRequest::GetLogDestination ( ) const
inline

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Definition at line 497 of file CreateFlowLogsRequest.h.

◆ GetLogDestinationType()

const LogDestinationType& Aws::EC2::Model::CreateFlowLogsRequest::GetLogDestinationType ( ) const
inline

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Definition at line 425 of file CreateFlowLogsRequest.h.

◆ GetLogFormat()

const Aws::String& Aws::EC2::Model::CreateFlowLogsRequest::GetLogFormat ( ) const
inline

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Only applicable to flow logs that are published to an Amazon S3 bucket.

Definition at line 623 of file CreateFlowLogsRequest.h.

◆ GetLogGroupName()

const Aws::String& Aws::EC2::Model::CreateFlowLogsRequest::GetLogGroupName ( ) const
inline

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 222 of file CreateFlowLogsRequest.h.

◆ GetResourceIds()

const Aws::Vector<Aws::String>& Aws::EC2::Model::CreateFlowLogsRequest::GetResourceIds ( ) const
inline

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Definition at line 285 of file CreateFlowLogsRequest.h.

◆ GetResourceType()

const FlowLogsResourceType& Aws::EC2::Model::CreateFlowLogsRequest::GetResourceType ( ) const
inline

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Definition at line 341 of file CreateFlowLogsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::EC2::Model::CreateFlowLogsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 44 of file CreateFlowLogsRequest.h.

◆ GetTrafficType()

const TrafficType& Aws::EC2::Model::CreateFlowLogsRequest::GetTrafficType ( ) const
inline

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Definition at line 383 of file CreateFlowLogsRequest.h.

◆ LogDestinationHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::LogDestinationHasBeenSet ( ) const
inline

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Definition at line 513 of file CreateFlowLogsRequest.h.

◆ LogDestinationTypeHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::LogDestinationTypeHasBeenSet ( ) const
inline

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Definition at line 436 of file CreateFlowLogsRequest.h.

◆ LogFormatHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::LogFormatHasBeenSet ( ) const
inline

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Only applicable to flow logs that are published to an Amazon S3 bucket.

Definition at line 636 of file CreateFlowLogsRequest.h.

◆ LogGroupNameHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::LogGroupNameHasBeenSet ( ) const
inline

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 230 of file CreateFlowLogsRequest.h.

◆ ResourceIdsHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::ResourceIdsHasBeenSet ( ) const
inline

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Definition at line 291 of file CreateFlowLogsRequest.h.

◆ ResourceTypeHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::ResourceTypeHasBeenSet ( ) const
inline

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Definition at line 348 of file CreateFlowLogsRequest.h.

◆ SerializePayload()

Aws::String Aws::EC2::Model::CreateFlowLogsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetClientToken ( const Aws::String value)
inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Definition at line 108 of file CreateFlowLogsRequest.h.

◆ SetClientToken() [2/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetClientToken ( Aws::String &&  value)
inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Definition at line 116 of file CreateFlowLogsRequest.h.

◆ SetClientToken() [3/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetClientToken ( const char *  value)
inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Definition at line 124 of file CreateFlowLogsRequest.h.

◆ SetDeliverLogsPermissionArn() [1/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetDeliverLogsPermissionArn ( const Aws::String value)
inline

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 173 of file CreateFlowLogsRequest.h.

◆ SetDeliverLogsPermissionArn() [2/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetDeliverLogsPermissionArn ( Aws::String &&  value)
inline

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 181 of file CreateFlowLogsRequest.h.

◆ SetDeliverLogsPermissionArn() [3/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetDeliverLogsPermissionArn ( const char *  value)
inline

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 189 of file CreateFlowLogsRequest.h.

◆ SetDryRun()

void Aws::EC2::Model::CreateFlowLogsRequest::SetDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 75 of file CreateFlowLogsRequest.h.

◆ SetLogDestination() [1/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogDestination ( const Aws::String value)
inline

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Definition at line 529 of file CreateFlowLogsRequest.h.

◆ SetLogDestination() [2/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogDestination ( Aws::String &&  value)
inline

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Definition at line 545 of file CreateFlowLogsRequest.h.

◆ SetLogDestination() [3/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogDestination ( const char *  value)
inline

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Definition at line 561 of file CreateFlowLogsRequest.h.

◆ SetLogDestinationType() [1/2]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogDestinationType ( const LogDestinationType value)
inline

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Definition at line 447 of file CreateFlowLogsRequest.h.

◆ SetLogDestinationType() [2/2]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogDestinationType ( LogDestinationType &&  value)
inline

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Definition at line 458 of file CreateFlowLogsRequest.h.

◆ SetLogFormat() [1/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogFormat ( const Aws::String value)
inline

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Only applicable to flow logs that are published to an Amazon S3 bucket.

Definition at line 649 of file CreateFlowLogsRequest.h.

◆ SetLogFormat() [2/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogFormat ( Aws::String &&  value)
inline

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Only applicable to flow logs that are published to an Amazon S3 bucket.

Definition at line 662 of file CreateFlowLogsRequest.h.

◆ SetLogFormat() [3/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogFormat ( const char *  value)
inline

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Only applicable to flow logs that are published to an Amazon S3 bucket.

Definition at line 675 of file CreateFlowLogsRequest.h.

◆ SetLogGroupName() [1/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogGroupName ( const Aws::String value)
inline

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 238 of file CreateFlowLogsRequest.h.

◆ SetLogGroupName() [2/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogGroupName ( Aws::String &&  value)
inline

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 246 of file CreateFlowLogsRequest.h.

◆ SetLogGroupName() [3/3]

void Aws::EC2::Model::CreateFlowLogsRequest::SetLogGroupName ( const char *  value)
inline

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 254 of file CreateFlowLogsRequest.h.

◆ SetResourceIds() [1/2]

void Aws::EC2::Model::CreateFlowLogsRequest::SetResourceIds ( const Aws::Vector< Aws::String > &  value)
inline

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Definition at line 297 of file CreateFlowLogsRequest.h.

◆ SetResourceIds() [2/2]

void Aws::EC2::Model::CreateFlowLogsRequest::SetResourceIds ( Aws::Vector< Aws::String > &&  value)
inline

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Definition at line 303 of file CreateFlowLogsRequest.h.

◆ SetResourceType() [1/2]

void Aws::EC2::Model::CreateFlowLogsRequest::SetResourceType ( const FlowLogsResourceType value)
inline

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Definition at line 355 of file CreateFlowLogsRequest.h.

◆ SetResourceType() [2/2]

void Aws::EC2::Model::CreateFlowLogsRequest::SetResourceType ( FlowLogsResourceType &&  value)
inline

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Definition at line 362 of file CreateFlowLogsRequest.h.

◆ SetTrafficType() [1/2]

void Aws::EC2::Model::CreateFlowLogsRequest::SetTrafficType ( const TrafficType value)
inline

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Definition at line 395 of file CreateFlowLogsRequest.h.

◆ SetTrafficType() [2/2]

void Aws::EC2::Model::CreateFlowLogsRequest::SetTrafficType ( TrafficType &&  value)
inline

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Definition at line 401 of file CreateFlowLogsRequest.h.

◆ TrafficTypeHasBeenSet()

bool Aws::EC2::Model::CreateFlowLogsRequest::TrafficTypeHasBeenSet ( ) const
inline

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Definition at line 389 of file CreateFlowLogsRequest.h.

◆ WithClientToken() [1/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithClientToken ( const Aws::String value)
inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Definition at line 132 of file CreateFlowLogsRequest.h.

◆ WithClientToken() [2/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithClientToken ( Aws::String &&  value)
inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Definition at line 140 of file CreateFlowLogsRequest.h.

◆ WithClientToken() [3/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithClientToken ( const char *  value)
inline

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Definition at line 148 of file CreateFlowLogsRequest.h.

◆ WithDeliverLogsPermissionArn() [1/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithDeliverLogsPermissionArn ( const Aws::String value)
inline

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 197 of file CreateFlowLogsRequest.h.

◆ WithDeliverLogsPermissionArn() [2/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithDeliverLogsPermissionArn ( Aws::String &&  value)
inline

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 205 of file CreateFlowLogsRequest.h.

◆ WithDeliverLogsPermissionArn() [3/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithDeliverLogsPermissionArn ( const char *  value)
inline

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 213 of file CreateFlowLogsRequest.h.

◆ WithDryRun()

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithDryRun ( bool  value)
inline

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Definition at line 83 of file CreateFlowLogsRequest.h.

◆ WithLogDestination() [1/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogDestination ( const Aws::String value)
inline

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Definition at line 577 of file CreateFlowLogsRequest.h.

◆ WithLogDestination() [2/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogDestination ( Aws::String &&  value)
inline

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Definition at line 593 of file CreateFlowLogsRequest.h.

◆ WithLogDestination() [3/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogDestination ( const char *  value)
inline

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.

Definition at line 609 of file CreateFlowLogsRequest.h.

◆ WithLogDestinationType() [1/2]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogDestinationType ( const LogDestinationType value)
inline

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Definition at line 469 of file CreateFlowLogsRequest.h.

◆ WithLogDestinationType() [2/2]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogDestinationType ( LogDestinationType &&  value)
inline

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

Definition at line 480 of file CreateFlowLogsRequest.h.

◆ WithLogFormat() [1/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogFormat ( const Aws::String value)
inline

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Only applicable to flow logs that are published to an Amazon S3 bucket.

Definition at line 688 of file CreateFlowLogsRequest.h.

◆ WithLogFormat() [2/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogFormat ( Aws::String &&  value)
inline

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Only applicable to flow logs that are published to an Amazon S3 bucket.

Definition at line 701 of file CreateFlowLogsRequest.h.

◆ WithLogFormat() [3/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogFormat ( const char *  value)
inline

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ${field-id} format, separated by spaces. For the AWS CLI, use single quotation marks (' ') to surround the parameter value.

Only applicable to flow logs that are published to an Amazon S3 bucket.

Definition at line 714 of file CreateFlowLogsRequest.h.

◆ WithLogGroupName() [1/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogGroupName ( const Aws::String value)
inline

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 262 of file CreateFlowLogsRequest.h.

◆ WithLogGroupName() [2/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogGroupName ( Aws::String &&  value)
inline

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 270 of file CreateFlowLogsRequest.h.

◆ WithLogGroupName() [3/3]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithLogGroupName ( const char *  value)
inline

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

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Definition at line 278 of file CreateFlowLogsRequest.h.

◆ WithResourceIds() [1/2]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithResourceIds ( const Aws::Vector< Aws::String > &  value)
inline

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Definition at line 309 of file CreateFlowLogsRequest.h.

◆ WithResourceIds() [2/2]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithResourceIds ( Aws::Vector< Aws::String > &&  value)
inline

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

Definition at line 315 of file CreateFlowLogsRequest.h.

◆ WithResourceType() [1/2]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithResourceType ( const FlowLogsResourceType value)
inline

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Definition at line 369 of file CreateFlowLogsRequest.h.

◆ WithResourceType() [2/2]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithResourceType ( FlowLogsResourceType &&  value)
inline

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

Definition at line 376 of file CreateFlowLogsRequest.h.

◆ WithTrafficType() [1/2]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithTrafficType ( const TrafficType value)
inline

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Definition at line 407 of file CreateFlowLogsRequest.h.

◆ WithTrafficType() [2/2]

CreateFlowLogsRequest& Aws::EC2::Model::CreateFlowLogsRequest::WithTrafficType ( TrafficType &&  value)
inline

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

Definition at line 413 of file CreateFlowLogsRequest.h.


The documentation for this class was generated from the following file: