Interface CreateMonitorRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateMonitorRequest.Builder,
,CreateMonitorRequest> NetworkFlowMonitorRequest.Builder
,SdkBuilder<CreateMonitorRequest.Builder,
,CreateMonitorRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateMonitorRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.localResources
(Collection<MonitorLocalResource> localResources) The local resources to monitor.localResources
(Consumer<MonitorLocalResource.Builder>... localResources) The local resources to monitor.localResources
(MonitorLocalResource... localResources) The local resources to monitor.monitorName
(String monitorName) The name of the monitor.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.remoteResources
(Collection<MonitorRemoteResource> remoteResources) The remote resources to monitor.remoteResources
(Consumer<MonitorRemoteResource.Builder>... remoteResources) The remote resources to monitor.remoteResources
(MonitorRemoteResource... remoteResources) The remote resources to monitor.The Amazon Resource Name (ARN) of the scope for the monitor.The tags for a monitor.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
monitorName
The name of the monitor.
- Parameters:
monitorName
- The name of the monitor.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
localResources
The local resources to monitor. A local resource in a workload is the location of the host, or hosts, where the Network Flow Monitor agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Dynamo DB), the subnet with the EC2 instance that hosts the web service, which also runs the agent, is the local resource.
Be aware that all local resources must belong to the current Region.
- Parameters:
localResources
- The local resources to monitor. A local resource in a workload is the location of the host, or hosts, where the Network Flow Monitor agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Dynamo DB), the subnet with the EC2 instance that hosts the web service, which also runs the agent, is the local resource.Be aware that all local resources must belong to the current Region.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
localResources
The local resources to monitor. A local resource in a workload is the location of the host, or hosts, where the Network Flow Monitor agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Dynamo DB), the subnet with the EC2 instance that hosts the web service, which also runs the agent, is the local resource.
Be aware that all local resources must belong to the current Region.
- Parameters:
localResources
- The local resources to monitor. A local resource in a workload is the location of the host, or hosts, where the Network Flow Monitor agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Dynamo DB), the subnet with the EC2 instance that hosts the web service, which also runs the agent, is the local resource.Be aware that all local resources must belong to the current Region.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
localResources
CreateMonitorRequest.Builder localResources(Consumer<MonitorLocalResource.Builder>... localResources) The local resources to monitor. A local resource in a workload is the location of the host, or hosts, where the Network Flow Monitor agent is installed. For example, if a workload consists of an interaction between a web service and a backend database (for example, Amazon Dynamo DB), the subnet with the EC2 instance that hosts the web service, which also runs the agent, is the local resource.
Be aware that all local resources must belong to the current Region.
This is a convenience method that creates an instance of theMonitorLocalResource.Builder
avoiding the need to create one manually viaMonitorLocalResource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolocalResources(List<MonitorLocalResource>)
.- Parameters:
localResources
- a consumer that will call methods onMonitorLocalResource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
remoteResources
The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.
When you specify remote resources, be aware that specific combinations of resources are allowed and others are not, including the following constraints:
-
All remote resources that you specify must all belong to a single Region.
-
If you specify Amazon Web Services services as remote resources, any other remote resources that you specify must be in the current Region.
-
When you specify a remote resource for another Region, you can only specify the
Region
resource type. You cannot specify a subnet, VPC, or Availability Zone in another Region. -
If you leave the
RemoteResources
parameter empty, the monitor will include all network flows that terminate in the current Region.
- Parameters:
remoteResources
- The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.When you specify remote resources, be aware that specific combinations of resources are allowed and others are not, including the following constraints:
-
All remote resources that you specify must all belong to a single Region.
-
If you specify Amazon Web Services services as remote resources, any other remote resources that you specify must be in the current Region.
-
When you specify a remote resource for another Region, you can only specify the
Region
resource type. You cannot specify a subnet, VPC, or Availability Zone in another Region. -
If you leave the
RemoteResources
parameter empty, the monitor will include all network flows that terminate in the current Region.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
remoteResources
The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.
When you specify remote resources, be aware that specific combinations of resources are allowed and others are not, including the following constraints:
-
All remote resources that you specify must all belong to a single Region.
-
If you specify Amazon Web Services services as remote resources, any other remote resources that you specify must be in the current Region.
-
When you specify a remote resource for another Region, you can only specify the
Region
resource type. You cannot specify a subnet, VPC, or Availability Zone in another Region. -
If you leave the
RemoteResources
parameter empty, the monitor will include all network flows that terminate in the current Region.
- Parameters:
remoteResources
- The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.When you specify remote resources, be aware that specific combinations of resources are allowed and others are not, including the following constraints:
-
All remote resources that you specify must all belong to a single Region.
-
If you specify Amazon Web Services services as remote resources, any other remote resources that you specify must be in the current Region.
-
When you specify a remote resource for another Region, you can only specify the
Region
resource type. You cannot specify a subnet, VPC, or Availability Zone in another Region. -
If you leave the
RemoteResources
parameter empty, the monitor will include all network flows that terminate in the current Region.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
remoteResources
CreateMonitorRequest.Builder remoteResources(Consumer<MonitorRemoteResource.Builder>... remoteResources) The remote resources to monitor. A remote resource is the other endpoint in the bi-directional flow of a workload, with a local resource. For example, Amazon Dynamo DB can be a remote resource.
When you specify remote resources, be aware that specific combinations of resources are allowed and others are not, including the following constraints:
-
All remote resources that you specify must all belong to a single Region.
-
If you specify Amazon Web Services services as remote resources, any other remote resources that you specify must be in the current Region.
-
When you specify a remote resource for another Region, you can only specify the
Region
resource type. You cannot specify a subnet, VPC, or Availability Zone in another Region. -
If you leave the
RemoteResources
parameter empty, the monitor will include all network flows that terminate in the current Region.
MonitorRemoteResource.Builder
avoiding the need to create one manually viaMonitorRemoteResource.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toremoteResources(List<MonitorRemoteResource>)
.- Parameters:
remoteResources
- a consumer that will call methods onMonitorRemoteResource.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
scopeArn
The Amazon Resource Name (ARN) of the scope for the monitor.
- Parameters:
scopeArn
- The Amazon Resource Name (ARN) of the scope for the monitor.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.
- Parameters:
clientToken
- A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
The tags for a monitor. You can add a maximum of 200 tags.
- Parameters:
tags
- The tags for a monitor. You can add a maximum of 200 tags.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateMonitorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateMonitorRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-