1. Packages
  2. AWS
  3. API Docs
  4. ssmcontacts
  5. getPlan
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.ssmcontacts.getPlan

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Data source for managing a Plan of an AWS SSM Contact.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = aws.ssmcontacts.getPlan({
        contactId: "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.ssmcontacts.get_plan(contact_id="arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmcontacts"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ssmcontacts.LookupPlan(ctx, &ssmcontacts.LookupPlanArgs{
    			ContactId: "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Aws.SsmContacts.GetPlan.Invoke(new()
        {
            ContactId = "arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ssmcontacts.SsmcontactsFunctions;
    import com.pulumi.aws.ssmcontacts.inputs.GetPlanArgs;
    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) {
            final var test = SsmcontactsFunctions.getPlan(GetPlanArgs.builder()
                .contactId("arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: aws:ssmcontacts:getPlan
          Arguments:
            contactId: arn:aws:ssm-contacts:us-west-2:123456789012:contact/contactalias
    

    Using getPlan

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPlan(args: GetPlanArgs, opts?: InvokeOptions): Promise<GetPlanResult>
    function getPlanOutput(args: GetPlanOutputArgs, opts?: InvokeOptions): Output<GetPlanResult>
    def get_plan(contact_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPlanResult
    def get_plan_output(contact_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetPlanResult]
    func LookupPlan(ctx *Context, args *LookupPlanArgs, opts ...InvokeOption) (*LookupPlanResult, error)
    func LookupPlanOutput(ctx *Context, args *LookupPlanOutputArgs, opts ...InvokeOption) LookupPlanResultOutput

    > Note: This function is named LookupPlan in the Go SDK.

    public static class GetPlan 
    {
        public static Task<GetPlanResult> InvokeAsync(GetPlanArgs args, InvokeOptions? opts = null)
        public static Output<GetPlanResult> Invoke(GetPlanInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPlanResult> getPlan(GetPlanArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:ssmcontacts/getPlan:getPlan
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ContactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    ContactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    contactId String
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    contactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    contact_id str
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    contactId String
    The Amazon Resource Name (ARN) of the contact or escalation plan.

    getPlan Result

    The following output properties are available:

    ContactId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Stages List<GetPlanStage>
    List of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
    ContactId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Stages []GetPlanStage
    List of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
    contactId String
    id String
    The provider-assigned unique ID for this managed resource.
    stages List<GetPlanStage>
    List of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
    contactId string
    id string
    The provider-assigned unique ID for this managed resource.
    stages GetPlanStage[]
    List of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
    contact_id str
    id str
    The provider-assigned unique ID for this managed resource.
    stages Sequence[GetPlanStage]
    List of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.
    contactId String
    id String
    The provider-assigned unique ID for this managed resource.
    stages List<Property Map>
    List of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts.

    Supporting Types

    GetPlanStage

    GetPlanStageTarget

    GetPlanStageTargetChannelTargetInfo

    GetPlanStageTargetContactTargetInfo

    ContactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    IsEssential bool
    ContactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    IsEssential bool
    contactId String
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    isEssential Boolean
    contactId string
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    isEssential boolean
    contact_id str
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    is_essential bool
    contactId String
    The Amazon Resource Name (ARN) of the contact or escalation plan.
    isEssential Boolean

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi