Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. internetmonitor
  5. Monitor

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.internetmonitor.Monitor

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Represents a monitor, which defines the monitoring boundaries for measurements that Internet Monitor publishes information about for an application

    Create Monitor Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Monitor(name: string, args?: MonitorArgs, opts?: CustomResourceOptions);
    @overload
def Monitor(resource_name: str,
            args: Optional[MonitorArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Monitor(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            health_events_config: Optional[MonitorHealthEventsConfigArgs] = None,
            include_linked_accounts: Optional[bool] = None,
            internet_measurements_log_delivery: Optional[MonitorInternetMeasurementsLogDeliveryArgs] = None,
            linked_account_id: Optional[str] = None,
            max_city_networks_to_monitor: Optional[int] = None,
            monitor_name: Optional[str] = None,
            resources: Optional[Sequence[str]] = None,
            resources_to_add: Optional[Sequence[str]] = None,
            resources_to_remove: Optional[Sequence[str]] = None,
            status: Optional[MonitorConfigState] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
            traffic_percentage_to_monitor: Optional[int] = None)
    func NewMonitor(ctx *Context, name string, args *MonitorArgs, opts ...ResourceOption) (*Monitor, error)
    public Monitor(string name, MonitorArgs? args = null, CustomResourceOptions? opts = null)
    public Monitor(String name, MonitorArgs args)
public Monitor(String name, MonitorArgs args, CustomResourceOptions options)

    type: aws-native:internetmonitor:Monitor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Monitor Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Monitor resource accepts the following input properties:

    HealthEventsConfig Pulumi.AwsNative.InternetMonitor.Inputs.MonitorHealthEventsConfig

    A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.

    Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.

    You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.

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

    For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.

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

    IncludeLinkedAccounts bool
    A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    InternetMeasurementsLogDelivery Pulumi.AwsNative.InternetMonitor.Inputs.MonitorInternetMeasurementsLogDelivery
    Publish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket. Measurements are also published to Amazon CloudWatch Logs for the first 500 (by traffic volume) city-networks (client locations and ASNs, typically internet service providers or ISPs).
    LinkedAccountId string
    The account ID for an account that you've set up cross-account sharing for in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    MaxCityNetworksToMonitor int

    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 network, such as an internet service provider, that clients access the resources through.

    For more information, see Choosing a city-network maximum value in Using Amazon CloudWatch Internet Monitor .

    MonitorName string
    The name of the monitor. A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
    Resources List<string>

    The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). Use this option to add or remove resources when making an update.

    Be aware that if you include content in the Resources field when you update a monitor, the ResourcesToAdd and ResourcesToRemove fields must be empty.

    ResourcesToAdd List<string>

    The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be Amazon Virtual Private Cloud VPCs, Network Load Balancers (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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

    You can specify this field for a monitor update only if the Resources field is empty.

    ResourcesToRemove List<string>

    The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs)

    You can specify this field for a monitor update only if the Resources field is empty.

    Status Pulumi.AwsNative.InternetMonitor.MonitorConfigState
    The status of a monitor. The accepted values that you can specify for Status are ACTIVE and INACTIVE .
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags for a monitor, listed as a set of key:value pairs.
    TrafficPercentageToMonitor int
    The percentage of the internet-facing traffic for your application that you want to monitor. You can also, optionally, set a limit for the number of city-networks (client locations and ASNs, typically internet service providers) that Internet Monitor will monitor traffic for. The city-networks maximum limit caps the number of city-networks that Internet Monitor monitors for your application, regardless of the percentage of traffic that you choose to monitor.
    HealthEventsConfig MonitorHealthEventsConfigArgs

    A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.

    Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.

    You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.

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

    For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.

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

    IncludeLinkedAccounts bool
    A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    InternetMeasurementsLogDelivery MonitorInternetMeasurementsLogDeliveryArgs
    Publish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket. Measurements are also published to Amazon CloudWatch Logs for the first 500 (by traffic volume) city-networks (client locations and ASNs, typically internet service providers or ISPs).
    LinkedAccountId string
    The account ID for an account that you've set up cross-account sharing for in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    MaxCityNetworksToMonitor int

    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 network, such as an internet service provider, that clients access the resources through.

    For more information, see Choosing a city-network maximum value in Using Amazon CloudWatch Internet Monitor .

    MonitorName string
    The name of the monitor. A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
    Resources []string

    The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). Use this option to add or remove resources when making an update.

    Be aware that if you include content in the Resources field when you update a monitor, the ResourcesToAdd and ResourcesToRemove fields must be empty.

    ResourcesToAdd []string

    The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be Amazon Virtual Private Cloud VPCs, Network Load Balancers (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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

    You can specify this field for a monitor update only if the Resources field is empty.

    ResourcesToRemove []string

    The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs)

    You can specify this field for a monitor update only if the Resources field is empty.

    Status MonitorConfigState
    The status of a monitor. The accepted values that you can specify for Status are ACTIVE and INACTIVE .
    Tags TagArgs
    The tags for a monitor, listed as a set of key:value pairs.
    TrafficPercentageToMonitor int
    The percentage of the internet-facing traffic for your application that you want to monitor. You can also, optionally, set a limit for the number of city-networks (client locations and ASNs, typically internet service providers) that Internet Monitor will monitor traffic for. The city-networks maximum limit caps the number of city-networks that Internet Monitor monitors for your application, regardless of the percentage of traffic that you choose to monitor.
    healthEventsConfig MonitorHealthEventsConfig

    A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.

    Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.

    You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.

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

    For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.

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

    includeLinkedAccounts Boolean
    A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    internetMeasurementsLogDelivery MonitorInternetMeasurementsLogDelivery
    Publish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket. Measurements are also published to Amazon CloudWatch Logs for the first 500 (by traffic volume) city-networks (client locations and ASNs, typically internet service providers or ISPs).
    linkedAccountId String
    The account ID for an account that you've set up cross-account sharing for in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    maxCityNetworksToMonitor Integer

    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 network, such as an internet service provider, that clients access the resources through.

    For more information, see Choosing a city-network maximum value in Using Amazon CloudWatch Internet Monitor .

    monitorName String
    The name of the monitor. A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
    resources List<String>

    The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). Use this option to add or remove resources when making an update.

    Be aware that if you include content in the Resources field when you update a monitor, the ResourcesToAdd and ResourcesToRemove fields must be empty.

    resourcesToAdd List<String>

    The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be Amazon Virtual Private Cloud VPCs, Network Load Balancers (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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

    You can specify this field for a monitor update only if the Resources field is empty.

    resourcesToRemove List<String>

    The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs)

    You can specify this field for a monitor update only if the Resources field is empty.

    status MonitorConfigState
    The status of a monitor. The accepted values that you can specify for Status are ACTIVE and INACTIVE .
    tags List<Tag>
    The tags for a monitor, listed as a set of key:value pairs.
    trafficPercentageToMonitor Integer
    The percentage of the internet-facing traffic for your application that you want to monitor. You can also, optionally, set a limit for the number of city-networks (client locations and ASNs, typically internet service providers) that Internet Monitor will monitor traffic for. The city-networks maximum limit caps the number of city-networks that Internet Monitor monitors for your application, regardless of the percentage of traffic that you choose to monitor.
    healthEventsConfig MonitorHealthEventsConfig

    A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.

    Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.

    You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.

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

    For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.

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

    includeLinkedAccounts boolean
    A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    internetMeasurementsLogDelivery MonitorInternetMeasurementsLogDelivery
    Publish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket. Measurements are also published to Amazon CloudWatch Logs for the first 500 (by traffic volume) city-networks (client locations and ASNs, typically internet service providers or ISPs).
    linkedAccountId string
    The account ID for an account that you've set up cross-account sharing for in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    maxCityNetworksToMonitor number

    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 network, such as an internet service provider, that clients access the resources through.

    For more information, see Choosing a city-network maximum value in Using Amazon CloudWatch Internet Monitor .

    monitorName string
    The name of the monitor. A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
    resources string[]

    The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). Use this option to add or remove resources when making an update.

    Be aware that if you include content in the Resources field when you update a monitor, the ResourcesToAdd and ResourcesToRemove fields must be empty.

    resourcesToAdd string[]

    The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be Amazon Virtual Private Cloud VPCs, Network Load Balancers (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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

    You can specify this field for a monitor update only if the Resources field is empty.

    resourcesToRemove string[]

    The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs)

    You can specify this field for a monitor update only if the Resources field is empty.

    status MonitorConfigState
    The status of a monitor. The accepted values that you can specify for Status are ACTIVE and INACTIVE .
    tags Tag[]
    The tags for a monitor, listed as a set of key:value pairs.
    trafficPercentageToMonitor number
    The percentage of the internet-facing traffic for your application that you want to monitor. You can also, optionally, set a limit for the number of city-networks (client locations and ASNs, typically internet service providers) that Internet Monitor will monitor traffic for. The city-networks maximum limit caps the number of city-networks that Internet Monitor monitors for your application, regardless of the percentage of traffic that you choose to monitor.
    health_events_config MonitorHealthEventsConfigArgs

    A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.

    Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.

    You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.

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

    For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.

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

    include_linked_accounts bool
    A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    internet_measurements_log_delivery MonitorInternetMeasurementsLogDeliveryArgs
    Publish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket. Measurements are also published to Amazon CloudWatch Logs for the first 500 (by traffic volume) city-networks (client locations and ASNs, typically internet service providers or ISPs).
    linked_account_id str
    The account ID for an account that you've set up cross-account sharing for in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    max_city_networks_to_monitor int

    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 network, such as an internet service provider, that clients access the resources through.

    For more information, see Choosing a city-network maximum value in Using Amazon CloudWatch Internet Monitor .

    monitor_name str
    The name of the monitor. A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
    resources Sequence[str]

    The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). Use this option to add or remove resources when making an update.

    Be aware that if you include content in the Resources field when you update a monitor, the ResourcesToAdd and ResourcesToRemove fields must be empty.

    resources_to_add Sequence[str]

    The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be Amazon Virtual Private Cloud VPCs, Network Load Balancers (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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

    You can specify this field for a monitor update only if the Resources field is empty.

    resources_to_remove Sequence[str]

    The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs)

    You can specify this field for a monitor update only if the Resources field is empty.

    status MonitorConfigState
    The status of a monitor. The accepted values that you can specify for Status are ACTIVE and INACTIVE .
    tags Sequence[TagArgs]
    The tags for a monitor, listed as a set of key:value pairs.
    traffic_percentage_to_monitor int
    The percentage of the internet-facing traffic for your application that you want to monitor. You can also, optionally, set a limit for the number of city-networks (client locations and ASNs, typically internet service providers) that Internet Monitor will monitor traffic for. The city-networks maximum limit caps the number of city-networks that Internet Monitor monitors for your application, regardless of the percentage of traffic that you choose to monitor.
    healthEventsConfig Property Map

    A complex type with the configuration information that determines the threshold and other conditions for when Internet Monitor creates a health event for an overall performance or availability issue, across an application's geographies.

    Defines the percentages, for overall performance scores and availability scores for an application, that are the thresholds for when Amazon CloudWatch Internet Monitor creates a health event. You can override the defaults to set a custom threshold for overall performance or availability scores, or both.

    You can also set thresholds for local health scores,, where Internet Monitor creates a health event when scores cross a threshold for one or more city-networks, in addition to creating an event when an overall score crosses a threshold.

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

    For local thresholds, you also set a minimum percentage of overall traffic that is impacted by an issue before Internet Monitor creates an event. In addition, you can disable local thresholds, for performance scores, availability scores, or both.

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

    includeLinkedAccounts Boolean
    A boolean option that you can set to TRUE to include monitors for linked accounts in a list of monitors, when you've set up cross-account sharing in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    internetMeasurementsLogDelivery Property Map
    Publish internet measurements for a monitor for all city-networks (up to the 500,000 service limit) to another location, such as an Amazon S3 bucket. Measurements are also published to Amazon CloudWatch Logs for the first 500 (by traffic volume) city-networks (client locations and ASNs, typically internet service providers or ISPs).
    linkedAccountId String
    The account ID for an account that you've set up cross-account sharing for in Internet Monitor. You configure cross-account sharing by using Amazon CloudWatch Observability Access Manager. For more information, see Internet Monitor cross-account observability in the Amazon CloudWatch User Guide.
    maxCityNetworksToMonitor Number

    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 network, such as an internet service provider, that clients access the resources through.

    For more information, see Choosing a city-network maximum value in Using Amazon CloudWatch Internet Monitor .

    monitorName String
    The name of the monitor. A monitor name can contain only alphanumeric characters, dashes (-), periods (.), and underscores (_).
    resources List<String>

    The resources that have been added for the monitor, listed by their Amazon Resource Names (ARNs). Use this option to add or remove resources when making an update.

    Be aware that if you include content in the Resources field when you update a monitor, the ResourcesToAdd and ResourcesToRemove fields must be empty.

    resourcesToAdd List<String>

    The resources to include in a monitor, which you provide as a set of Amazon Resource Names (ARNs). Resources can be Amazon Virtual Private Cloud VPCs, Network Load Balancers (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 VPC resources, at least one VPC must have an Internet Gateway attached to it, to make sure that it has internet connectivity.

    You can specify this field for a monitor update only if the Resources field is empty.

    resourcesToRemove List<String>

    The resources to remove from a monitor, which you provide as a set of Amazon Resource Names (ARNs)

    You can specify this field for a monitor update only if the Resources field is empty.

    status "PENDING" | "ACTIVE" | "INACTIVE" | "ERROR"
    The status of a monitor. The accepted values that you can specify for Status are ACTIVE and INACTIVE .
    tags List<Property Map>
    The tags for a monitor, listed as a set of key:value pairs.
    trafficPercentageToMonitor Number
    The percentage of the internet-facing traffic for your application that you want to monitor. You can also, optionally, set a limit for the number of city-networks (client locations and ASNs, typically internet service providers) that Internet Monitor will monitor traffic for. The city-networks maximum limit caps the number of city-networks that Internet Monitor monitors for your application, regardless of the percentage of traffic that you choose to monitor.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Monitor resource produces the following output properties:

    CreatedAt string
    The time when the monitor was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedAt string
    The last time that the monitor was modified.
    MonitorArn string
    The Amazon Resource Name (ARN) of the monitor.
    ProcessingStatus Pulumi.AwsNative.InternetMonitor.MonitorProcessingStatusCode
    The health of data processing for the monitor. For more information, see ProcessingStatus under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .
    ProcessingStatusInfo string
    Additional information about the health of the data processing for the monitor.
    CreatedAt string
    The time when the monitor was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedAt string
    The last time that the monitor was modified.
    MonitorArn string
    The Amazon Resource Name (ARN) of the monitor.
    ProcessingStatus MonitorProcessingStatusCode
    The health of data processing for the monitor. For more information, see ProcessingStatus under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .
    ProcessingStatusInfo string
    Additional information about the health of the data processing for the monitor.
    createdAt String
    The time when the monitor was created.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedAt String
    The last time that the monitor was modified.
    monitorArn String
    The Amazon Resource Name (ARN) of the monitor.
    processingStatus MonitorProcessingStatusCode
    The health of data processing for the monitor. For more information, see ProcessingStatus under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .
    processingStatusInfo String
    Additional information about the health of the data processing for the monitor.
    createdAt string
    The time when the monitor was created.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedAt string
    The last time that the monitor was modified.
    monitorArn string
    The Amazon Resource Name (ARN) of the monitor.
    processingStatus MonitorProcessingStatusCode
    The health of data processing for the monitor. For more information, see ProcessingStatus under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .
    processingStatusInfo string
    Additional information about the health of the data processing for the monitor.
    created_at str
    The time when the monitor was created.
    id str
    The provider-assigned unique ID for this managed resource.
    modified_at str
    The last time that the monitor was modified.
    monitor_arn str
    The Amazon Resource Name (ARN) of the monitor.
    processing_status MonitorProcessingStatusCode
    The health of data processing for the monitor. For more information, see ProcessingStatus under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .
    processing_status_info str
    Additional information about the health of the data processing for the monitor.
    createdAt String
    The time when the monitor was created.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedAt String
    The last time that the monitor was modified.
    monitorArn String
    The Amazon Resource Name (ARN) of the monitor.
    processingStatus "OK" | "INACTIVE" | "COLLECTING_DATA" | "INSUFFICIENT_DATA" | "FAULT_SERVICE" | "FAULT_ACCESS_CLOUDWATCH"
    The health of data processing for the monitor. For more information, see ProcessingStatus under MonitorListMember in the Amazon CloudWatch Internet Monitor API Reference .
    processingStatusInfo String
    Additional information about the health of the data processing for the monitor.

    Supporting Types

    MonitorConfigState, MonitorConfigStateArgs

    Pending
    PENDING
    Active
    ACTIVE
    Inactive
    INACTIVE
    Error
    ERROR
    MonitorConfigStatePending
    PENDING
    MonitorConfigStateActive
    ACTIVE
    MonitorConfigStateInactive
    INACTIVE
    MonitorConfigStateError
    ERROR
    Pending
    PENDING
    Active
    ACTIVE
    Inactive
    INACTIVE
    Error
    ERROR
    Pending
    PENDING
    Active
    ACTIVE
    Inactive
    INACTIVE
    Error
    ERROR
    PENDING
    PENDING
    ACTIVE
    ACTIVE
    INACTIVE
    INACTIVE
    ERROR
    ERROR
    "PENDING"
    PENDING
    "ACTIVE"
    ACTIVE
    "INACTIVE"
    INACTIVE
    "ERROR"
    ERROR

    MonitorHealthEventsConfig, MonitorHealthEventsConfigArgs

    AvailabilityLocalHealthEventsConfig Pulumi.AwsNative.InternetMonitor.Inputs.MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
    AvailabilityScoreThreshold double
    The health event threshold percentage set for availability scores. When the overall availability score is at or below this percentage, Internet Monitor creates a health event.
    PerformanceLocalHealthEventsConfig Pulumi.AwsNative.InternetMonitor.Inputs.MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
    PerformanceScoreThreshold double
    The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event.
    AvailabilityLocalHealthEventsConfig MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
    AvailabilityScoreThreshold float64
    The health event threshold percentage set for availability scores. When the overall availability score is at or below this percentage, Internet Monitor creates a health event.
    PerformanceLocalHealthEventsConfig MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
    PerformanceScoreThreshold float64
    The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event.
    availabilityLocalHealthEventsConfig MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
    availabilityScoreThreshold Double
    The health event threshold percentage set for availability scores. When the overall availability score is at or below this percentage, Internet Monitor creates a health event.
    performanceLocalHealthEventsConfig MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
    performanceScoreThreshold Double
    The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event.
    availabilityLocalHealthEventsConfig MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
    availabilityScoreThreshold number
    The health event threshold percentage set for availability scores. When the overall availability score is at or below this percentage, Internet Monitor creates a health event.
    performanceLocalHealthEventsConfig MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
    performanceScoreThreshold number
    The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event.
    availability_local_health_events_config MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
    availability_score_threshold float
    The health event threshold percentage set for availability scores. When the overall availability score is at or below this percentage, Internet Monitor creates a health event.
    performance_local_health_events_config MonitorLocalHealthEventsConfig
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
    performance_score_threshold float
    The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event.
    availabilityLocalHealthEventsConfig Property Map
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local availability issue.
    availabilityScoreThreshold Number
    The health event threshold percentage set for availability scores. When the overall availability score is at or below this percentage, Internet Monitor creates a health event.
    performanceLocalHealthEventsConfig Property Map
    The configuration that determines the threshold and other conditions for when Internet Monitor creates a health event for a local performance issue.
    performanceScoreThreshold Number
    The health event threshold percentage set for performance scores. When the overall performance score is at or below this percentage, Internet Monitor creates a health event.

    MonitorInternetMeasurementsLogDelivery, MonitorInternetMeasurementsLogDeliveryArgs

    S3Config Pulumi.AwsNative.InternetMonitor.Inputs.MonitorS3Config
    The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.
    S3Config MonitorS3Config
    The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.
    s3Config MonitorS3Config
    The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.
    s3Config MonitorS3Config
    The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.
    s3_config MonitorS3Config
    The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.
    s3Config Property Map
    The configuration for publishing Amazon CloudWatch Internet Monitor internet measurements to Amazon S3.

    MonitorLocalHealthEventsConfig, MonitorLocalHealthEventsConfigArgs

    HealthScoreThreshold double
    The health event threshold percentage set for a local health score.
    MinTrafficImpact double

    The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

    If you don't set a minimum traffic impact threshold, the default value is 0.01%.

    Status Pulumi.AwsNative.InternetMonitor.MonitorLocalHealthEventsConfigStatus
    The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED .
    HealthScoreThreshold float64
    The health event threshold percentage set for a local health score.
    MinTrafficImpact float64

    The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

    If you don't set a minimum traffic impact threshold, the default value is 0.01%.

    Status MonitorLocalHealthEventsConfigStatus
    The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED .
    healthScoreThreshold Double
    The health event threshold percentage set for a local health score.
    minTrafficImpact Double

    The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

    If you don't set a minimum traffic impact threshold, the default value is 0.01%.

    status MonitorLocalHealthEventsConfigStatus
    The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED .
    healthScoreThreshold number
    The health event threshold percentage set for a local health score.
    minTrafficImpact number

    The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

    If you don't set a minimum traffic impact threshold, the default value is 0.01%.

    status MonitorLocalHealthEventsConfigStatus
    The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED .
    health_score_threshold float
    The health event threshold percentage set for a local health score.
    min_traffic_impact float

    The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

    If you don't set a minimum traffic impact threshold, the default value is 0.01%.

    status MonitorLocalHealthEventsConfigStatus
    The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED .
    healthScoreThreshold Number
    The health event threshold percentage set for a local health score.
    minTrafficImpact Number

    The minimum percentage of overall traffic for an application that must be impacted by an issue before Internet Monitor creates an event when a threshold is crossed for a local health score.

    If you don't set a minimum traffic impact threshold, the default value is 0.01%.

    status "ENABLED" | "DISABLED"
    The status of whether Internet Monitor creates a health event based on a threshold percentage set for a local health score. The status can be ENABLED or DISABLED .

    MonitorLocalHealthEventsConfigStatus, MonitorLocalHealthEventsConfigStatusArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    MonitorLocalHealthEventsConfigStatusEnabled
    ENABLED
    MonitorLocalHealthEventsConfigStatusDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    MonitorProcessingStatusCode, MonitorProcessingStatusCodeArgs

    Ok
    OK
    Inactive
    INACTIVE
    CollectingData
    COLLECTING_DATA
    InsufficientData
    INSUFFICIENT_DATA
    FaultService
    FAULT_SERVICE
    FaultAccessCloudwatch
    FAULT_ACCESS_CLOUDWATCH
    MonitorProcessingStatusCodeOk
    OK
    MonitorProcessingStatusCodeInactive
    INACTIVE
    MonitorProcessingStatusCodeCollectingData
    COLLECTING_DATA
    MonitorProcessingStatusCodeInsufficientData
    INSUFFICIENT_DATA
    MonitorProcessingStatusCodeFaultService
    FAULT_SERVICE
    MonitorProcessingStatusCodeFaultAccessCloudwatch
    FAULT_ACCESS_CLOUDWATCH
    Ok
    OK
    Inactive
    INACTIVE
    CollectingData
    COLLECTING_DATA
    InsufficientData
    INSUFFICIENT_DATA
    FaultService
    FAULT_SERVICE
    FaultAccessCloudwatch
    FAULT_ACCESS_CLOUDWATCH
    Ok
    OK
    Inactive
    INACTIVE
    CollectingData
    COLLECTING_DATA
    InsufficientData
    INSUFFICIENT_DATA
    FaultService
    FAULT_SERVICE
    FaultAccessCloudwatch
    FAULT_ACCESS_CLOUDWATCH
    OK
    OK
    INACTIVE
    INACTIVE
    COLLECTING_DATA
    COLLECTING_DATA
    INSUFFICIENT_DATA
    INSUFFICIENT_DATA
    FAULT_SERVICE
    FAULT_SERVICE
    FAULT_ACCESS_CLOUDWATCH
    FAULT_ACCESS_CLOUDWATCH
    "OK"
    OK
    "INACTIVE"
    INACTIVE
    "COLLECTING_DATA"
    COLLECTING_DATA
    "INSUFFICIENT_DATA"
    INSUFFICIENT_DATA
    "FAULT_SERVICE"
    FAULT_SERVICE
    "FAULT_ACCESS_CLOUDWATCH"
    FAULT_ACCESS_CLOUDWATCH

    MonitorS3Config, MonitorS3ConfigArgs

    BucketName string
    The Amazon S3 bucket name for internet measurements publishing.
    BucketPrefix string
    An optional Amazon S3 bucket prefix for internet measurements publishing.
    LogDeliveryStatus Pulumi.AwsNative.InternetMonitor.MonitorS3ConfigLogDeliveryStatus
    The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is ENABLED if you choose to deliver internet measurements to an S3 bucket, and DISABLED otherwise.
    BucketName string
    The Amazon S3 bucket name for internet measurements publishing.
    BucketPrefix string
    An optional Amazon S3 bucket prefix for internet measurements publishing.
    LogDeliveryStatus MonitorS3ConfigLogDeliveryStatus
    The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is ENABLED if you choose to deliver internet measurements to an S3 bucket, and DISABLED otherwise.
    bucketName String
    The Amazon S3 bucket name for internet measurements publishing.
    bucketPrefix String
    An optional Amazon S3 bucket prefix for internet measurements publishing.
    logDeliveryStatus MonitorS3ConfigLogDeliveryStatus
    The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is ENABLED if you choose to deliver internet measurements to an S3 bucket, and DISABLED otherwise.
    bucketName string
    The Amazon S3 bucket name for internet measurements publishing.
    bucketPrefix string
    An optional Amazon S3 bucket prefix for internet measurements publishing.
    logDeliveryStatus MonitorS3ConfigLogDeliveryStatus
    The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is ENABLED if you choose to deliver internet measurements to an S3 bucket, and DISABLED otherwise.
    bucket_name str
    The Amazon S3 bucket name for internet measurements publishing.
    bucket_prefix str
    An optional Amazon S3 bucket prefix for internet measurements publishing.
    log_delivery_status MonitorS3ConfigLogDeliveryStatus
    The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is ENABLED if you choose to deliver internet measurements to an S3 bucket, and DISABLED otherwise.
    bucketName String
    The Amazon S3 bucket name for internet measurements publishing.
    bucketPrefix String
    An optional Amazon S3 bucket prefix for internet measurements publishing.
    logDeliveryStatus "ENABLED" | "DISABLED"
    The status of publishing Internet Monitor internet measurements to an Amazon S3 bucket. The delivery status is ENABLED if you choose to deliver internet measurements to an S3 bucket, and DISABLED otherwise.

    MonitorS3ConfigLogDeliveryStatus, MonitorS3ConfigLogDeliveryStatusArgs

    Enabled
    ENABLED
    Disabled
    DISABLED
    MonitorS3ConfigLogDeliveryStatusEnabled
    ENABLED
    MonitorS3ConfigLogDeliveryStatusDisabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    Enabled
    ENABLED
    Disabled
    DISABLED
    ENABLED
    ENABLED
    DISABLED
    DISABLED
    "ENABLED"
    ENABLED
    "DISABLED"
    DISABLED

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native