Interface CreateMonitorRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateMonitorRequest.Builder,CreateMonitorRequest>, InternetMonitorRequest.Builder, SdkBuilder<CreateMonitorRequest.Builder,CreateMonitorRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateMonitorRequest
@Mutable @NotThreadSafe public static interface CreateMonitorRequest.Builder extends InternetMonitorRequest.Builder, SdkPojo, CopyableBuilder<CreateMonitorRequest.Builder,CreateMonitorRequest>

  • Method Details

    • monitorName

      CreateMonitorRequest.Builder monitorName(String 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.

    • resources

      CreateMonitorRequest.Builder resources(Collection<String> resources)

      The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.

      You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.

      If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

      Parameters:
      resources - The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.

      You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.

      If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      CreateMonitorRequest.Builder resources(String... resources)

      The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.

      You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.

      If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

      Parameters:
      resources - The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be VPCs, NLBs, Amazon CloudFront distributions, or Amazon WorkSpaces directories.

      You can add a combination of VPCs and CloudFront distributions, or you can add WorkSpaces directories, or you can add NLBs. You can't add NLBs or WorkSpaces directories together with any other resources.

      If you add only Amazon VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateMonitorRequest.Builder clientToken(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.

      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

      CreateMonitorRequest.Builder tags(Map<String,String> tags)

      The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.

      Parameters:
      tags - The tags for a monitor. You can add a maximum of 50 tags in Internet Monitor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxCityNetworksToMonitor

      CreateMonitorRequest.Builder maxCityNetworksToMonitor(Integer maxCityNetworksToMonitor)

      The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.

      To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

      Parameters:
      maxCityNetworksToMonitor - The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the ASN or network provider, such as an internet service provider (ISP), that clients access the resources through. Setting this limit can help control billing costs.

      To learn more, see Choosing a city-network maximum value in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • internetMeasurementsLogDelivery

      CreateMonitorRequest.Builder internetMeasurementsLogDelivery(InternetMeasurementsLogDelivery internetMeasurementsLogDelivery)

      Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.

      Parameters:
      internetMeasurementsLogDelivery - Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • internetMeasurementsLogDelivery

      default CreateMonitorRequest.Builder internetMeasurementsLogDelivery(Consumer<InternetMeasurementsLogDelivery.Builder> internetMeasurementsLogDelivery)

      Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs.

      This is a convenience method that creates an instance of the InternetMeasurementsLogDelivery.Builder avoiding the need to create one manually via InternetMeasurementsLogDelivery.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to internetMeasurementsLogDelivery(InternetMeasurementsLogDelivery).

      Parameters:
      internetMeasurementsLogDelivery - a consumer that will call methods on InternetMeasurementsLogDelivery.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trafficPercentageToMonitor

      CreateMonitorRequest.Builder trafficPercentageToMonitor(Integer trafficPercentageToMonitor)

      The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

      To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

      Parameters:
      trafficPercentageToMonitor - The percentage of the internet-facing traffic for your application that you want to monitor with this monitor. If you set a city-networks maximum, that limit overrides the traffic percentage that you set.

      To learn more, see Choosing an application traffic percentage to monitor in the Amazon CloudWatch Internet Monitor section of the CloudWatch User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthEventsConfig

      CreateMonitorRequest.Builder healthEventsConfig(HealthEventsConfig healthEventsConfig)

      Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.

      If you don't set a health event threshold, the default value is 95%.

      For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

      Parameters:
      healthEventsConfig - Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.

      If you don't set a health event threshold, the default value is 95%.

      For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • healthEventsConfig

      default CreateMonitorRequest.Builder healthEventsConfig(Consumer<HealthEventsConfig.Builder> healthEventsConfig)

      Defines the threshold percentages and other configuration information for when Amazon CloudWatch Internet Monitor creates a health event. Internet Monitor creates a health event when an internet issue that affects your application end users has a health score percentage that is at or below a specific threshold, and, sometimes, when other criteria are met.

      If you don't set a health event threshold, the default value is 95%.

      For more information, see Change health event thresholds in the Internet Monitor section of the CloudWatch User Guide.

      This is a convenience method that creates an instance of the HealthEventsConfig.Builder avoiding the need to create one manually via HealthEventsConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to healthEventsConfig(HealthEventsConfig).

      Parameters:
      healthEventsConfig - a consumer that will call methods on HealthEventsConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateMonitorRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.