1. Packages
  2. Cisco Meraki
  3. API Docs
  4. organizations
  5. AlertsProfiles
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

meraki.organizations.AlertsProfiles

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.meraki.organizations.AlertsProfiles;
    import com.pulumi.meraki.organizations.AlertsProfilesArgs;
    import com.pulumi.meraki.organizations.inputs.AlertsProfilesAlertConditionArgs;
    import com.pulumi.meraki.organizations.inputs.AlertsProfilesRecipientsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new AlertsProfiles("example", AlertsProfilesArgs.builder()
                .alertCondition(AlertsProfilesAlertConditionArgs.builder()
                    .bit_rate_bps(10000)
                    .duration(60)
                    .interface_("wan1")
                    .jitter_ms(100)
                    .latency_ms(100)
                    .loss_ratio(0.1)
                    .mos(3.5)
                    .window(600)
                    .build())
                .description("WAN 1 high utilization")
                .networkTags(            
                    "tag1",
                    "tag2")
                .organizationId("string")
                .recipients(AlertsProfilesRecipientsArgs.builder()
                    .emails("admin@example.org")
                    .http_server_ids("aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA==")
                    .build())
                .type("wanUtilization")
                .build());
    
            ctx.export("merakiOrganizationsAlertsProfilesExample", example);
        }
    }
    
    resources:
      example:
        type: meraki:organizations:AlertsProfiles
        properties:
          alertCondition:
            bit_rate_bps: 10000
            duration: 60
            interface: wan1
            jitter_ms: 100
            latency_ms: 100
            loss_ratio: 0.1
            mos: 3.5
            window: 600
          description: WAN 1 high utilization
          networkTags:
            - tag1
            - tag2
          organizationId: string
          recipients:
            emails:
              - admin@example.org
            http_server_ids:
              - aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA==
          type: wanUtilization
    outputs:
      merakiOrganizationsAlertsProfilesExample: ${example}
    

    Create AlertsProfiles Resource

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

    Constructor syntax

    new AlertsProfiles(name: string, args: AlertsProfilesArgs, opts?: CustomResourceOptions);
    @overload
    def AlertsProfiles(resource_name: str,
                       args: AlertsProfilesArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def AlertsProfiles(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       organization_id: Optional[str] = None,
                       alert_condition: Optional[AlertsProfilesAlertConditionArgs] = None,
                       alert_config_id: Optional[str] = None,
                       description: Optional[str] = None,
                       enabled: Optional[bool] = None,
                       network_tags: Optional[Sequence[str]] = None,
                       recipients: Optional[AlertsProfilesRecipientsArgs] = None,
                       type: Optional[str] = None)
    func NewAlertsProfiles(ctx *Context, name string, args AlertsProfilesArgs, opts ...ResourceOption) (*AlertsProfiles, error)
    public AlertsProfiles(string name, AlertsProfilesArgs args, CustomResourceOptions? opts = null)
    public AlertsProfiles(String name, AlertsProfilesArgs args)
    public AlertsProfiles(String name, AlertsProfilesArgs args, CustomResourceOptions options)
    
    type: meraki:organizations:AlertsProfiles
    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 AlertsProfilesArgs
    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 AlertsProfilesArgs
    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 AlertsProfilesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlertsProfilesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlertsProfilesArgs
    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.

    var alertsProfilesResource = new Meraki.Organizations.AlertsProfiles("alertsProfilesResource", new()
    {
        OrganizationId = "string",
        AlertCondition = new Meraki.Organizations.Inputs.AlertsProfilesAlertConditionArgs
        {
            BitRateBps = 0,
            Duration = 0,
            Interface = "string",
            JitterMs = 0,
            LatencyMs = 0,
            LossRatio = 0,
            Mos = 0,
            Window = 0,
        },
        AlertConfigId = "string",
        Description = "string",
        Enabled = false,
        NetworkTags = new[]
        {
            "string",
        },
        Recipients = new Meraki.Organizations.Inputs.AlertsProfilesRecipientsArgs
        {
            Emails = new[]
            {
                "string",
            },
            HttpServerIds = new[]
            {
                "string",
            },
        },
        Type = "string",
    });
    
    example, err := organizations.NewAlertsProfiles(ctx, "alertsProfilesResource", &organizations.AlertsProfilesArgs{
    	OrganizationId: pulumi.String("string"),
    	AlertCondition: &organizations.AlertsProfilesAlertConditionArgs{
    		BitRateBps: pulumi.Int(0),
    		Duration:   pulumi.Int(0),
    		Interface:  pulumi.String("string"),
    		JitterMs:   pulumi.Int(0),
    		LatencyMs:  pulumi.Int(0),
    		LossRatio:  pulumi.Float64(0),
    		Mos:        pulumi.Float64(0),
    		Window:     pulumi.Int(0),
    	},
    	AlertConfigId: pulumi.String("string"),
    	Description:   pulumi.String("string"),
    	Enabled:       pulumi.Bool(false),
    	NetworkTags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Recipients: &organizations.AlertsProfilesRecipientsArgs{
    		Emails: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		HttpServerIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	Type: pulumi.String("string"),
    })
    
    var alertsProfilesResource = new AlertsProfiles("alertsProfilesResource", AlertsProfilesArgs.builder()        
        .organizationId("string")
        .alertCondition(AlertsProfilesAlertConditionArgs.builder()
            .bitRateBps(0)
            .duration(0)
            .interface_("string")
            .jitterMs(0)
            .latencyMs(0)
            .lossRatio(0)
            .mos(0)
            .window(0)
            .build())
        .alertConfigId("string")
        .description("string")
        .enabled(false)
        .networkTags("string")
        .recipients(AlertsProfilesRecipientsArgs.builder()
            .emails("string")
            .httpServerIds("string")
            .build())
        .type("string")
        .build());
    
    alerts_profiles_resource = meraki.organizations.AlertsProfiles("alertsProfilesResource",
        organization_id="string",
        alert_condition=meraki.organizations.AlertsProfilesAlertConditionArgs(
            bit_rate_bps=0,
            duration=0,
            interface="string",
            jitter_ms=0,
            latency_ms=0,
            loss_ratio=0,
            mos=0,
            window=0,
        ),
        alert_config_id="string",
        description="string",
        enabled=False,
        network_tags=["string"],
        recipients=meraki.organizations.AlertsProfilesRecipientsArgs(
            emails=["string"],
            http_server_ids=["string"],
        ),
        type="string")
    
    const alertsProfilesResource = new meraki.organizations.AlertsProfiles("alertsProfilesResource", {
        organizationId: "string",
        alertCondition: {
            bitRateBps: 0,
            duration: 0,
            "interface": "string",
            jitterMs: 0,
            latencyMs: 0,
            lossRatio: 0,
            mos: 0,
            window: 0,
        },
        alertConfigId: "string",
        description: "string",
        enabled: false,
        networkTags: ["string"],
        recipients: {
            emails: ["string"],
            httpServerIds: ["string"],
        },
        type: "string",
    });
    
    type: meraki:organizations:AlertsProfiles
    properties:
        alertCondition:
            bitRateBps: 0
            duration: 0
            interface: string
            jitterMs: 0
            latencyMs: 0
            lossRatio: 0
            mos: 0
            window: 0
        alertConfigId: string
        description: string
        enabled: false
        networkTags:
            - string
        organizationId: string
        recipients:
            emails:
                - string
            httpServerIds:
                - string
        type: string
    

    AlertsProfiles 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 AlertsProfiles resource accepts the following input properties:

    OrganizationId string
    organizationId path parameter. Organization ID
    AlertCondition AlertsProfilesAlertCondition
    The conditions that determine if the alert triggers
    AlertConfigId string
    alertConfigId path parameter. Alert config ID
    Description string
    User supplied description of the alert
    Enabled bool
    Is the alert config enabled
    NetworkTags List<string>
    Networks with these tags will be monitored for the alert
    Recipients AlertsProfilesRecipients
    List of recipients that will recieve the alert.
    Type string
    The alert type
    OrganizationId string
    organizationId path parameter. Organization ID
    AlertCondition AlertsProfilesAlertConditionArgs
    The conditions that determine if the alert triggers
    AlertConfigId string
    alertConfigId path parameter. Alert config ID
    Description string
    User supplied description of the alert
    Enabled bool
    Is the alert config enabled
    NetworkTags []string
    Networks with these tags will be monitored for the alert
    Recipients AlertsProfilesRecipientsArgs
    List of recipients that will recieve the alert.
    Type string
    The alert type
    organizationId String
    organizationId path parameter. Organization ID
    alertCondition AlertsProfilesAlertCondition
    The conditions that determine if the alert triggers
    alertConfigId String
    alertConfigId path parameter. Alert config ID
    description String
    User supplied description of the alert
    enabled Boolean
    Is the alert config enabled
    networkTags List<String>
    Networks with these tags will be monitored for the alert
    recipients AlertsProfilesRecipients
    List of recipients that will recieve the alert.
    type String
    The alert type
    organizationId string
    organizationId path parameter. Organization ID
    alertCondition AlertsProfilesAlertCondition
    The conditions that determine if the alert triggers
    alertConfigId string
    alertConfigId path parameter. Alert config ID
    description string
    User supplied description of the alert
    enabled boolean
    Is the alert config enabled
    networkTags string[]
    Networks with these tags will be monitored for the alert
    recipients AlertsProfilesRecipients
    List of recipients that will recieve the alert.
    type string
    The alert type
    organization_id str
    organizationId path parameter. Organization ID
    alert_condition AlertsProfilesAlertConditionArgs
    The conditions that determine if the alert triggers
    alert_config_id str
    alertConfigId path parameter. Alert config ID
    description str
    User supplied description of the alert
    enabled bool
    Is the alert config enabled
    network_tags Sequence[str]
    Networks with these tags will be monitored for the alert
    recipients AlertsProfilesRecipientsArgs
    List of recipients that will recieve the alert.
    type str
    The alert type
    organizationId String
    organizationId path parameter. Organization ID
    alertCondition Property Map
    The conditions that determine if the alert triggers
    alertConfigId String
    alertConfigId path parameter. Alert config ID
    description String
    User supplied description of the alert
    enabled Boolean
    Is the alert config enabled
    networkTags List<String>
    Networks with these tags will be monitored for the alert
    recipients Property Map
    List of recipients that will recieve the alert.
    type String
    The alert type

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AlertsProfiles Resource

    Get an existing AlertsProfiles resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AlertsProfilesState, opts?: CustomResourceOptions): AlertsProfiles
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alert_condition: Optional[AlertsProfilesAlertConditionArgs] = None,
            alert_config_id: Optional[str] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            network_tags: Optional[Sequence[str]] = None,
            organization_id: Optional[str] = None,
            recipients: Optional[AlertsProfilesRecipientsArgs] = None,
            type: Optional[str] = None) -> AlertsProfiles
    func GetAlertsProfiles(ctx *Context, name string, id IDInput, state *AlertsProfilesState, opts ...ResourceOption) (*AlertsProfiles, error)
    public static AlertsProfiles Get(string name, Input<string> id, AlertsProfilesState? state, CustomResourceOptions? opts = null)
    public static AlertsProfiles get(String name, Output<String> id, AlertsProfilesState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AlertCondition AlertsProfilesAlertCondition
    The conditions that determine if the alert triggers
    AlertConfigId string
    alertConfigId path parameter. Alert config ID
    Description string
    User supplied description of the alert
    Enabled bool
    Is the alert config enabled
    NetworkTags List<string>
    Networks with these tags will be monitored for the alert
    OrganizationId string
    organizationId path parameter. Organization ID
    Recipients AlertsProfilesRecipients
    List of recipients that will recieve the alert.
    Type string
    The alert type
    AlertCondition AlertsProfilesAlertConditionArgs
    The conditions that determine if the alert triggers
    AlertConfigId string
    alertConfigId path parameter. Alert config ID
    Description string
    User supplied description of the alert
    Enabled bool
    Is the alert config enabled
    NetworkTags []string
    Networks with these tags will be monitored for the alert
    OrganizationId string
    organizationId path parameter. Organization ID
    Recipients AlertsProfilesRecipientsArgs
    List of recipients that will recieve the alert.
    Type string
    The alert type
    alertCondition AlertsProfilesAlertCondition
    The conditions that determine if the alert triggers
    alertConfigId String
    alertConfigId path parameter. Alert config ID
    description String
    User supplied description of the alert
    enabled Boolean
    Is the alert config enabled
    networkTags List<String>
    Networks with these tags will be monitored for the alert
    organizationId String
    organizationId path parameter. Organization ID
    recipients AlertsProfilesRecipients
    List of recipients that will recieve the alert.
    type String
    The alert type
    alertCondition AlertsProfilesAlertCondition
    The conditions that determine if the alert triggers
    alertConfigId string
    alertConfigId path parameter. Alert config ID
    description string
    User supplied description of the alert
    enabled boolean
    Is the alert config enabled
    networkTags string[]
    Networks with these tags will be monitored for the alert
    organizationId string
    organizationId path parameter. Organization ID
    recipients AlertsProfilesRecipients
    List of recipients that will recieve the alert.
    type string
    The alert type
    alert_condition AlertsProfilesAlertConditionArgs
    The conditions that determine if the alert triggers
    alert_config_id str
    alertConfigId path parameter. Alert config ID
    description str
    User supplied description of the alert
    enabled bool
    Is the alert config enabled
    network_tags Sequence[str]
    Networks with these tags will be monitored for the alert
    organization_id str
    organizationId path parameter. Organization ID
    recipients AlertsProfilesRecipientsArgs
    List of recipients that will recieve the alert.
    type str
    The alert type
    alertCondition Property Map
    The conditions that determine if the alert triggers
    alertConfigId String
    alertConfigId path parameter. Alert config ID
    description String
    User supplied description of the alert
    enabled Boolean
    Is the alert config enabled
    networkTags List<String>
    Networks with these tags will be monitored for the alert
    organizationId String
    organizationId path parameter. Organization ID
    recipients Property Map
    List of recipients that will recieve the alert.
    type String
    The alert type

    Supporting Types

    AlertsProfilesAlertCondition, AlertsProfilesAlertConditionArgs

    BitRateBps int
    The threshold the metric must cross to be valid for alerting. Used only for WAN Utilization alerts.
    Duration int
    The total duration in seconds that the threshold should be crossed before alerting
    Interface string
    The uplink observed for the alert
    JitterMs int
    The threshold the metric must cross to be valid for alerting. Used only for VoIP Jitter alerts.
    LatencyMs int
    The threshold the metric must cross to be valid for alerting. Used only for WAN Latency alerts.
    LossRatio double
    The threshold the metric must cross to be valid for alerting. Used only for Packet Loss alerts.
    Mos double
    The threshold the metric must drop below to be valid for alerting. Used only for VoIP MOS alerts.
    Window int
    The look back period in seconds for sensing the alert
    BitRateBps int
    The threshold the metric must cross to be valid for alerting. Used only for WAN Utilization alerts.
    Duration int
    The total duration in seconds that the threshold should be crossed before alerting
    Interface string
    The uplink observed for the alert
    JitterMs int
    The threshold the metric must cross to be valid for alerting. Used only for VoIP Jitter alerts.
    LatencyMs int
    The threshold the metric must cross to be valid for alerting. Used only for WAN Latency alerts.
    LossRatio float64
    The threshold the metric must cross to be valid for alerting. Used only for Packet Loss alerts.
    Mos float64
    The threshold the metric must drop below to be valid for alerting. Used only for VoIP MOS alerts.
    Window int
    The look back period in seconds for sensing the alert
    bitRateBps Integer
    The threshold the metric must cross to be valid for alerting. Used only for WAN Utilization alerts.
    duration Integer
    The total duration in seconds that the threshold should be crossed before alerting
    interface_ String
    The uplink observed for the alert
    jitterMs Integer
    The threshold the metric must cross to be valid for alerting. Used only for VoIP Jitter alerts.
    latencyMs Integer
    The threshold the metric must cross to be valid for alerting. Used only for WAN Latency alerts.
    lossRatio Double
    The threshold the metric must cross to be valid for alerting. Used only for Packet Loss alerts.
    mos Double
    The threshold the metric must drop below to be valid for alerting. Used only for VoIP MOS alerts.
    window Integer
    The look back period in seconds for sensing the alert
    bitRateBps number
    The threshold the metric must cross to be valid for alerting. Used only for WAN Utilization alerts.
    duration number
    The total duration in seconds that the threshold should be crossed before alerting
    interface string
    The uplink observed for the alert
    jitterMs number
    The threshold the metric must cross to be valid for alerting. Used only for VoIP Jitter alerts.
    latencyMs number
    The threshold the metric must cross to be valid for alerting. Used only for WAN Latency alerts.
    lossRatio number
    The threshold the metric must cross to be valid for alerting. Used only for Packet Loss alerts.
    mos number
    The threshold the metric must drop below to be valid for alerting. Used only for VoIP MOS alerts.
    window number
    The look back period in seconds for sensing the alert
    bit_rate_bps int
    The threshold the metric must cross to be valid for alerting. Used only for WAN Utilization alerts.
    duration int
    The total duration in seconds that the threshold should be crossed before alerting
    interface str
    The uplink observed for the alert
    jitter_ms int
    The threshold the metric must cross to be valid for alerting. Used only for VoIP Jitter alerts.
    latency_ms int
    The threshold the metric must cross to be valid for alerting. Used only for WAN Latency alerts.
    loss_ratio float
    The threshold the metric must cross to be valid for alerting. Used only for Packet Loss alerts.
    mos float
    The threshold the metric must drop below to be valid for alerting. Used only for VoIP MOS alerts.
    window int
    The look back period in seconds for sensing the alert
    bitRateBps Number
    The threshold the metric must cross to be valid for alerting. Used only for WAN Utilization alerts.
    duration Number
    The total duration in seconds that the threshold should be crossed before alerting
    interface String
    The uplink observed for the alert
    jitterMs Number
    The threshold the metric must cross to be valid for alerting. Used only for VoIP Jitter alerts.
    latencyMs Number
    The threshold the metric must cross to be valid for alerting. Used only for WAN Latency alerts.
    lossRatio Number
    The threshold the metric must cross to be valid for alerting. Used only for Packet Loss alerts.
    mos Number
    The threshold the metric must drop below to be valid for alerting. Used only for VoIP MOS alerts.
    window Number
    The look back period in seconds for sensing the alert

    AlertsProfilesRecipients, AlertsProfilesRecipientsArgs

    Emails List<string>
    A list of emails that will receive information about the alert
    HttpServerIds List<string>
    A list base64 encoded urls of webhook endpoints that will receive information about the alert
    Emails []string
    A list of emails that will receive information about the alert
    HttpServerIds []string
    A list base64 encoded urls of webhook endpoints that will receive information about the alert
    emails List<String>
    A list of emails that will receive information about the alert
    httpServerIds List<String>
    A list base64 encoded urls of webhook endpoints that will receive information about the alert
    emails string[]
    A list of emails that will receive information about the alert
    httpServerIds string[]
    A list base64 encoded urls of webhook endpoints that will receive information about the alert
    emails Sequence[str]
    A list of emails that will receive information about the alert
    http_server_ids Sequence[str]
    A list base64 encoded urls of webhook endpoints that will receive information about the alert
    emails List<String>
    A list of emails that will receive information about the alert
    httpServerIds List<String>
    A list base64 encoded urls of webhook endpoints that will receive information about the alert

    Import

    $ pulumi import meraki:organizations/alertsProfiles:AlertsProfiles example "organization_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.2.0 published on Friday, May 24, 2024 by Pulumi