1. Packages
  2. AWS Native
  3. API Docs
  4. ssmcontacts
  5. getPlan

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

AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi

aws-native.ssmcontacts.getPlan

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.79.0 published on Monday, Oct 2, 2023 by Pulumi

    Engagement Plan for a SSM Incident Manager Contact.

    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(arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetPlanResult
    def get_plan_output(arn: 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-native:ssmcontacts:getPlan
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Arn string

    The Amazon Resource Name (ARN) of the contact.

    Arn string

    The Amazon Resource Name (ARN) of the contact.

    arn String

    The Amazon Resource Name (ARN) of the contact.

    arn string

    The Amazon Resource Name (ARN) of the contact.

    arn str

    The Amazon Resource Name (ARN) of the contact.

    arn String

    The Amazon Resource Name (ARN) of the contact.

    getPlan Result

    The following output properties are available:

    Arn string

    The Amazon Resource Name (ARN) of the contact.

    Stages List<Pulumi.AwsNative.SsmContacts.Outputs.PlanStage>

    The stages that an escalation plan or engagement plan engages contacts and contact methods in.

    Arn string

    The Amazon Resource Name (ARN) of the contact.

    Stages []PlanStage

    The stages that an escalation plan or engagement plan engages contacts and contact methods in.

    arn String

    The Amazon Resource Name (ARN) of the contact.

    stages List<PlanStage>

    The stages that an escalation plan or engagement plan engages contacts and contact methods in.

    arn string

    The Amazon Resource Name (ARN) of the contact.

    stages PlanStage[]

    The stages that an escalation plan or engagement plan engages contacts and contact methods in.

    arn str

    The Amazon Resource Name (ARN) of the contact.

    stages Sequence[PlanStage]

    The stages that an escalation plan or engagement plan engages contacts and contact methods in.

    arn String

    The Amazon Resource Name (ARN) of the contact.

    stages List<Property Map>

    The stages that an escalation plan or engagement plan engages contacts and contact methods in.

    Supporting Types

    PlanChannelTargetInfo

    ChannelId string

    The Amazon Resource Name (ARN) of the contact channel.

    RetryIntervalInMinutes int

    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

    ChannelId string

    The Amazon Resource Name (ARN) of the contact channel.

    RetryIntervalInMinutes int

    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

    channelId String

    The Amazon Resource Name (ARN) of the contact channel.

    retryIntervalInMinutes Integer

    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

    channelId string

    The Amazon Resource Name (ARN) of the contact channel.

    retryIntervalInMinutes number

    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

    channel_id str

    The Amazon Resource Name (ARN) of the contact channel.

    retry_interval_in_minutes int

    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

    channelId String

    The Amazon Resource Name (ARN) of the contact channel.

    retryIntervalInMinutes Number

    The number of minutes to wait to retry sending engagement in the case the engagement initially fails.

    PlanContactTargetInfo

    ContactId string

    The Amazon Resource Name (ARN) of the contact.

    IsEssential bool

    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

    ContactId string

    The Amazon Resource Name (ARN) of the contact.

    IsEssential bool

    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

    contactId String

    The Amazon Resource Name (ARN) of the contact.

    isEssential Boolean

    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

    contactId string

    The Amazon Resource Name (ARN) of the contact.

    isEssential boolean

    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

    contact_id str

    The Amazon Resource Name (ARN) of the contact.

    is_essential bool

    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

    contactId String

    The Amazon Resource Name (ARN) of the contact.

    isEssential Boolean

    A Boolean value determining if the contact's acknowledgement stops the progress of stages in the plan.

    PlanStage

    DurationInMinutes int

    The time to wait until beginning the next stage.

    Targets List<Pulumi.AwsNative.SsmContacts.Inputs.PlanTargets>

    The contacts or contact methods that the escalation plan or engagement plan is engaging.

    DurationInMinutes int

    The time to wait until beginning the next stage.

    Targets []PlanTargets

    The contacts or contact methods that the escalation plan or engagement plan is engaging.

    durationInMinutes Integer

    The time to wait until beginning the next stage.

    targets List<PlanTargets>

    The contacts or contact methods that the escalation plan or engagement plan is engaging.

    durationInMinutes number

    The time to wait until beginning the next stage.

    targets PlanTargets[]

    The contacts or contact methods that the escalation plan or engagement plan is engaging.

    duration_in_minutes int

    The time to wait until beginning the next stage.

    targets Sequence[PlanTargets]

    The contacts or contact methods that the escalation plan or engagement plan is engaging.

    durationInMinutes Number

    The time to wait until beginning the next stage.

    targets List<Property Map>

    The contacts or contact methods that the escalation plan or engagement plan is engaging.

    PlanTargets

    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.79.0 published on Monday, Oct 2, 2023 by Pulumi