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.105.0 published on Thursday, May 2, 2024 by Pulumi

aws-native.internetmonitor.Monitor

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const monitorResource = new aws_native.internetmonitor.Monitor("monitorResource", {
        healthEventsConfig: {
            availabilityLocalHealthEventsConfig: {
                healthScoreThreshold: 0,
                minTrafficImpact: 0,
                status: aws_native.internetmonitor.MonitorLocalHealthEventsConfigStatus.Enabled,
            },
            availabilityScoreThreshold: 0,
            performanceLocalHealthEventsConfig: {
                healthScoreThreshold: 0,
                minTrafficImpact: 0,
                status: aws_native.internetmonitor.MonitorLocalHealthEventsConfigStatus.Enabled,
            },
            performanceScoreThreshold: 0,
        },
        includeLinkedAccounts: false,
        internetMeasurementsLogDelivery: {
            s3Config: {
                bucketName: "string",
                bucketPrefix: "string",
                logDeliveryStatus: aws_native.internetmonitor.MonitorS3ConfigLogDeliveryStatus.Enabled,
            },
        },
        linkedAccountId: "string",
        maxCityNetworksToMonitor: 0,
        monitorName: "string",
        resources: ["string"],
        resourcesToAdd: ["string"],
        resourcesToRemove: ["string"],
        status: aws_native.internetmonitor.MonitorConfigState.Pending,
        tags: [{
            key: "string",
            value: "string",
        }],
        trafficPercentageToMonitor: 0,
    });
    
    Coming soon!
    

    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:

    Outputs

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

    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedAt string
    MonitorArn string
    ProcessingStatus Pulumi.AwsNative.InternetMonitor.MonitorProcessingStatusCode
    ProcessingStatusInfo string
    CreatedAt string
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedAt string
    MonitorArn string
    ProcessingStatus MonitorProcessingStatusCode
    ProcessingStatusInfo string
    createdAt String
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedAt String
    monitorArn String
    processingStatus MonitorProcessingStatusCode
    processingStatusInfo String
    createdAt string
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedAt string
    monitorArn string
    processingStatus MonitorProcessingStatusCode
    processingStatusInfo string
    created_at str
    id str
    The provider-assigned unique ID for this managed resource.
    modified_at str
    monitor_arn str
    processing_status MonitorProcessingStatusCode
    processing_status_info str

    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

    MonitorInternetMeasurementsLogDelivery, MonitorInternetMeasurementsLogDeliveryArgs

    MonitorLocalHealthEventsConfig, MonitorLocalHealthEventsConfigArgs

    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

    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.105.0 published on Thursday, May 2, 2024 by Pulumi