Class CreateMonitorRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorRequest
software.amazon.awssdk.services.networkflowmonitor.model.CreateMonitorRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateMonitorRequest.Builder,CreateMonitorRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateMonitorRequest extends NetworkFlowMonitorRequest implements ToCopyableBuilder<CreateMonitorRequest.Builder,CreateMonitorRequest>

  • Method Details

    • monitorName

      public final String monitorName()

      The name of the monitor.

      Returns:
      The name of the monitor.

    • hasLocalResources

      public final boolean hasLocalResources()
      For responses, this returns true if the service returned a value for the LocalResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • localResources

      public final List<MonitorLocalResource> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLocalResources() method.

      Returns:
      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.

    • hasRemoteResources

      public final boolean hasRemoteResources()
      For responses, this returns true if the service returned a value for the RemoteResources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • remoteResources

      public final List<MonitorRemoteResource> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRemoteResources() method.

      Returns:
      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.

    • scopeArn

      public final String scopeArn()

      The Amazon Resource Name (ARN) of the scope for the monitor.

      Returns:
      The Amazon Resource Name (ARN) of the scope for the monitor.

    • clientToken

      public final String 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:
      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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The tags for a monitor. You can add a maximum of 200 tags.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags for a monitor. You can add a maximum of 200 tags.

    • toBuilder

      public CreateMonitorRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateMonitorRequest.Builder,CreateMonitorRequest>
      Specified by:
      toBuilder in class NetworkFlowMonitorRequest
      Returns:
      a builder for type T

    • builder

      public static CreateMonitorRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateMonitorRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.