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

aws.ssmcontacts.getContactChannel

Explore with Pulumi AI

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

    Data source for managing an AWS SSM Contacts Contact Channel.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.ssmcontacts.getContactChannel({
        arn: "arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.ssmcontacts.get_contact_channel(arn="arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example")
    
    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.LookupContactChannel(ctx, &ssmcontacts.LookupContactChannelArgs{
    			Arn: "arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example",
    		}, 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 example = Aws.SsmContacts.GetContactChannel.Invoke(new()
        {
            Arn = "arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example",
        });
    
    });
    
    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.GetContactChannelArgs;
    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 example = SsmcontactsFunctions.getContactChannel(GetContactChannelArgs.builder()
                .arn("arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:ssmcontacts:getContactChannel
          Arguments:
            arn: arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example
    

    Using getContactChannel

    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 getContactChannel(args: GetContactChannelArgs, opts?: InvokeOptions): Promise<GetContactChannelResult>
    function getContactChannelOutput(args: GetContactChannelOutputArgs, opts?: InvokeOptions): Output<GetContactChannelResult>
    def get_contact_channel(arn: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetContactChannelResult
    def get_contact_channel_output(arn: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetContactChannelResult]
    func LookupContactChannel(ctx *Context, args *LookupContactChannelArgs, opts ...InvokeOption) (*LookupContactChannelResult, error)
    func LookupContactChannelOutput(ctx *Context, args *LookupContactChannelOutputArgs, opts ...InvokeOption) LookupContactChannelResultOutput

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

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

    The following arguments are supported:

    Arn string
    Amazon Resource Name (ARN) of the contact channel.
    Arn string
    Amazon Resource Name (ARN) of the contact channel.
    arn String
    Amazon Resource Name (ARN) of the contact channel.
    arn string
    Amazon Resource Name (ARN) of the contact channel.
    arn str
    Amazon Resource Name (ARN) of the contact channel.
    arn String
    Amazon Resource Name (ARN) of the contact channel.

    getContactChannel Result

    The following output properties are available:

    ActivationStatus string
    Whether the contact channel is activated.
    Arn string
    ContactId string
    Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to.
    DeliveryAddresses List<GetContactChannelDeliveryAddress>
    Details used to engage the contact channel.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the contact channel.
    Type string
    Type of the contact channel.
    ActivationStatus string
    Whether the contact channel is activated.
    Arn string
    ContactId string
    Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to.
    DeliveryAddresses []GetContactChannelDeliveryAddress
    Details used to engage the contact channel.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of the contact channel.
    Type string
    Type of the contact channel.
    activationStatus String
    Whether the contact channel is activated.
    arn String
    contactId String
    Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to.
    deliveryAddresses List<GetContactChannelDeliveryAddress>
    Details used to engage the contact channel.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the contact channel.
    type String
    Type of the contact channel.
    activationStatus string
    Whether the contact channel is activated.
    arn string
    contactId string
    Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to.
    deliveryAddresses GetContactChannelDeliveryAddress[]
    Details used to engage the contact channel.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of the contact channel.
    type string
    Type of the contact channel.
    activation_status str
    Whether the contact channel is activated.
    arn str
    contact_id str
    Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to.
    delivery_addresses Sequence[GetContactChannelDeliveryAddress]
    Details used to engage the contact channel.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of the contact channel.
    type str
    Type of the contact channel.
    activationStatus String
    Whether the contact channel is activated.
    arn String
    contactId String
    Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to.
    deliveryAddresses List<Property Map>
    Details used to engage the contact channel.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of the contact channel.
    type String
    Type of the contact channel.

    Supporting Types

    GetContactChannelDeliveryAddress

    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