Package com.pulumi.aws.ssmcontacts
Class Contact
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.ssmcontacts.Contact
-
public class Contact extends com.pulumi.resources.CustomResourceResource for managing an AWS SSM Contact. > **NOTE:** A contact implicitly depends on a replication set. If you configured your replication set in Pulumi, we recommend you add it to the `dependsOn` argument for the Contact Resource. ## Example Usage ### Basic Usage
### Usage With All Fieldspackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.ssmcontacts.Contact; import com.pulumi.aws.ssmcontacts.ContactArgs; import com.pulumi.resources.CustomResourceOptions; import java.util.ArrayList; import java.util.Arrays; 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 Contact("example", ContactArgs.builder() .alias("alias") .type("PERSONAL") .build(), CustomResourceOptions.builder() .dependsOn(exampleAwsSsmincidentsReplicationSet) .build()); } }
## Import ### Identity Schema #### Required - `arn` (String) ARN of the contact. Using `pulumi import`, import SSM Contact using the `ARN`. For example: ```sh $ pulumi import aws:ssmcontacts/contact:Contact example {ARNValue} ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.ssmcontacts.Contact; import com.pulumi.aws.ssmcontacts.ContactArgs; import com.pulumi.resources.CustomResourceOptions; import java.util.ArrayList; import java.util.Arrays; 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 Contact("example", ContactArgs.builder() .alias("alias") .displayName("displayName") .type("ESCALATION") .tags(Map.of("key", "value")) .build(), CustomResourceOptions.builder() .dependsOn(exampleAwsSsmincidentsReplicationSet) .build()); } }
-
-
Constructor Summary
Constructors Constructor Description Contact(java.lang.String name)Contact(java.lang.String name, ContactArgs args)Contact(java.lang.String name, ContactArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>alias()com.pulumi.core.Output<java.lang.String>arn()com.pulumi.core.Output<java.util.Optional<java.lang.String>>displayName()static Contactget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ContactState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>tags()com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>tagsAll()com.pulumi.core.Output<java.lang.String>type()
-
-
-
Constructor Detail
-
Contact
public Contact(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
Contact
public Contact(java.lang.String name, ContactArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
Contact
public Contact(java.lang.String name, ContactArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
alias
public com.pulumi.core.Output<java.lang.String> alias()
- Returns:
- A unique and identifiable alias for the contact or escalation plan. Must be between 1 and 255 characters, and may contain alphanumerics, underscores (`_`), and hyphens (`-`).
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- The ARN of the contact or escalation plan.
-
displayName
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> displayName()
- Returns:
- Full friendly name of the contact or escalation plan. If set, must be between 1 and 255 characters, and may contain alphanumerics, underscores (`_`), hyphens (`-`), periods (`.`), and spaces.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Key-value tags for the monitor. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
type
public com.pulumi.core.Output<java.lang.String> type()
- Returns:
- The type of contact engaged. A single contact is type PERSONAL and an escalation plan is type ESCALATION. The following arguments are optional:
-
get
public static Contact get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable ContactState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-