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

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

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

aws-native.ssmcontacts.Contact

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.111.0 published on Tuesday, Jul 9, 2024 by Pulumi

    Resource Type definition for AWS::SSMContacts::Contact

    Create Contact Resource

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

    Constructor syntax

    new Contact(name: string, args: ContactArgs, opts?: CustomResourceOptions);
    @overload
    def Contact(resource_name: str,
                args: ContactArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Contact(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                alias: Optional[str] = None,
                display_name: Optional[str] = None,
                type: Optional[ContactType] = None,
                plan: Optional[Sequence[ContactStageArgs]] = None)
    func NewContact(ctx *Context, name string, args ContactArgs, opts ...ResourceOption) (*Contact, error)
    public Contact(string name, ContactArgs args, CustomResourceOptions? opts = null)
    public Contact(String name, ContactArgs args)
    public Contact(String name, ContactArgs args, CustomResourceOptions options)
    
    type: aws-native:ssmcontacts:Contact
    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 ContactArgs
    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 ContactArgs
    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 ContactArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ContactArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ContactArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Alias string
    Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
    DisplayName string
    Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
    Type Pulumi.AwsNative.SsmContacts.ContactType
    Contact type, which specify type of contact. Currently supported values: "PERSONAL", "SHARED", "OTHER".
    Plan List<Pulumi.AwsNative.SsmContacts.Inputs.ContactStage>
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    Alias string
    Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
    DisplayName string
    Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
    Type ContactType
    Contact type, which specify type of contact. Currently supported values: "PERSONAL", "SHARED", "OTHER".
    Plan []ContactStageArgs
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    alias String
    Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
    displayName String
    Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
    type ContactType
    Contact type, which specify type of contact. Currently supported values: "PERSONAL", "SHARED", "OTHER".
    plan List<ContactStage>
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    alias string
    Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
    displayName string
    Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
    type ContactType
    Contact type, which specify type of contact. Currently supported values: "PERSONAL", "SHARED", "OTHER".
    plan ContactStage[]
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    alias str
    Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
    display_name str
    Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
    type ContactType
    Contact type, which specify type of contact. Currently supported values: "PERSONAL", "SHARED", "OTHER".
    plan Sequence[ContactStageArgs]
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.
    alias String
    Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed.
    displayName String
    Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed.
    type "PERSONAL" | "ESCALATION" | "ONCALL_SCHEDULE"
    Contact type, which specify type of contact. Currently supported values: "PERSONAL", "SHARED", "OTHER".
    plan List<Property Map>
    The stages that an escalation plan or engagement plan engages contacts and contact methods in.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) of the contact.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the contact.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the contact.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the contact.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the contact.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the contact.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ContactChannelTargetInfo, ContactChannelTargetInfoArgs

    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.

    ContactStage, ContactStageArgs

    DurationInMinutes int
    The time to wait until beginning the next stage.
    RotationIds List<string>
    List of Rotation Ids to associate with Contact
    Targets List<Pulumi.AwsNative.SsmContacts.Inputs.ContactTargets>
    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.
    RotationIds []string
    List of Rotation Ids to associate with Contact
    Targets []ContactTargets
    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.
    rotationIds List<String>
    List of Rotation Ids to associate with Contact
    targets List<ContactTargets>
    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.
    rotationIds string[]
    List of Rotation Ids to associate with Contact
    targets ContactTargets[]
    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.
    rotation_ids Sequence[str]
    List of Rotation Ids to associate with Contact
    targets Sequence[ContactTargets]
    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.
    rotationIds List<String>
    List of Rotation Ids to associate with Contact
    targets List<Property Map>
    The contacts or contact methods that the escalation plan or engagement plan is engaging.

    ContactTargetInfo, ContactTargetInfoArgs

    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.

    ContactTargets, ContactTargetsArgs

    ChannelTargetInfo Pulumi.AwsNative.SsmContacts.Inputs.ContactChannelTargetInfo
    Information about the contact channel that Incident Manager engages.
    ContactTargetInfo Pulumi.AwsNative.SsmContacts.Inputs.ContactTargetInfo
    The contact that Incident Manager is engaging during an incident.
    ChannelTargetInfo ContactChannelTargetInfo
    Information about the contact channel that Incident Manager engages.
    ContactTargetInfo ContactTargetInfo
    The contact that Incident Manager is engaging during an incident.
    channelTargetInfo ContactChannelTargetInfo
    Information about the contact channel that Incident Manager engages.
    contactTargetInfo ContactTargetInfo
    The contact that Incident Manager is engaging during an incident.
    channelTargetInfo ContactChannelTargetInfo
    Information about the contact channel that Incident Manager engages.
    contactTargetInfo ContactTargetInfo
    The contact that Incident Manager is engaging during an incident.
    channel_target_info ContactChannelTargetInfo
    Information about the contact channel that Incident Manager engages.
    contact_target_info ContactTargetInfo
    The contact that Incident Manager is engaging during an incident.
    channelTargetInfo Property Map
    Information about the contact channel that Incident Manager engages.
    contactTargetInfo Property Map
    The contact that Incident Manager is engaging during an incident.

    ContactType, ContactTypeArgs

    Personal
    PERSONAL
    Escalation
    ESCALATION
    OncallSchedule
    ONCALL_SCHEDULE
    ContactTypePersonal
    PERSONAL
    ContactTypeEscalation
    ESCALATION
    ContactTypeOncallSchedule
    ONCALL_SCHEDULE
    Personal
    PERSONAL
    Escalation
    ESCALATION
    OncallSchedule
    ONCALL_SCHEDULE
    Personal
    PERSONAL
    Escalation
    ESCALATION
    OncallSchedule
    ONCALL_SCHEDULE
    PERSONAL
    PERSONAL
    ESCALATION
    ESCALATION
    ONCALL_SCHEDULE
    ONCALL_SCHEDULE
    "PERSONAL"
    PERSONAL
    "ESCALATION"
    ESCALATION
    "ONCALL_SCHEDULE"
    ONCALL_SCHEDULE

    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.111.0 published on Tuesday, Jul 9, 2024 by Pulumi