aws.ssmincidents.ReplicationSet
Explore with Pulumi AI
Provides a resource for managing a replication set in AWS Systems Manager Incident Manager.
NOTE: Deleting a replication set also deletes all Incident Manager related data including response plans, incident records, contacts and escalation plans.
Example Usage
Basic Usage
Create a replication set.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const replicationSetName = new aws.ssmincidents.ReplicationSet("replicationSetName", {
regions: [{
name: "us-west-2",
}],
tags: {
exampleTag: "exampleValue",
},
});
import pulumi
import pulumi_aws as aws
replication_set_name = aws.ssmincidents.ReplicationSet("replicationSetName",
regions=[{
"name": "us-west-2",
}],
tags={
"exampleTag": "exampleValue",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmincidents"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ssmincidents.NewReplicationSet(ctx, "replicationSetName", &ssmincidents.ReplicationSetArgs{
Regions: ssmincidents.ReplicationSetRegionArray{
&ssmincidents.ReplicationSetRegionArgs{
Name: pulumi.String("us-west-2"),
},
},
Tags: pulumi.StringMap{
"exampleTag": pulumi.String("exampleValue"),
},
})
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 replicationSetName = new Aws.SsmIncidents.ReplicationSet("replicationSetName", new()
{
Regions = new[]
{
new Aws.SsmIncidents.Inputs.ReplicationSetRegionArgs
{
Name = "us-west-2",
},
},
Tags =
{
{ "exampleTag", "exampleValue" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssmincidents.ReplicationSet;
import com.pulumi.aws.ssmincidents.ReplicationSetArgs;
import com.pulumi.aws.ssmincidents.inputs.ReplicationSetRegionArgs;
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) {
var replicationSetName = new ReplicationSet("replicationSetName", ReplicationSetArgs.builder()
.regions(ReplicationSetRegionArgs.builder()
.name("us-west-2")
.build())
.tags(Map.of("exampleTag", "exampleValue"))
.build());
}
}
resources:
replicationSetName:
type: aws:ssmincidents:ReplicationSet
properties:
regions:
- name: us-west-2
tags:
exampleTag: exampleValue
Add a Region to a replication set. (You can add only one Region at a time.)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const replicationSetName = new aws.ssmincidents.ReplicationSet("replicationSetName", {regions: [
{
name: "us-west-2",
},
{
name: "ap-southeast-2",
},
]});
import pulumi
import pulumi_aws as aws
replication_set_name = aws.ssmincidents.ReplicationSet("replicationSetName", regions=[
{
"name": "us-west-2",
},
{
"name": "ap-southeast-2",
},
])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmincidents"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ssmincidents.NewReplicationSet(ctx, "replicationSetName", &ssmincidents.ReplicationSetArgs{
Regions: ssmincidents.ReplicationSetRegionArray{
&ssmincidents.ReplicationSetRegionArgs{
Name: pulumi.String("us-west-2"),
},
&ssmincidents.ReplicationSetRegionArgs{
Name: pulumi.String("ap-southeast-2"),
},
},
})
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 replicationSetName = new Aws.SsmIncidents.ReplicationSet("replicationSetName", new()
{
Regions = new[]
{
new Aws.SsmIncidents.Inputs.ReplicationSetRegionArgs
{
Name = "us-west-2",
},
new Aws.SsmIncidents.Inputs.ReplicationSetRegionArgs
{
Name = "ap-southeast-2",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssmincidents.ReplicationSet;
import com.pulumi.aws.ssmincidents.ReplicationSetArgs;
import com.pulumi.aws.ssmincidents.inputs.ReplicationSetRegionArgs;
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) {
var replicationSetName = new ReplicationSet("replicationSetName", ReplicationSetArgs.builder()
.regions(
ReplicationSetRegionArgs.builder()
.name("us-west-2")
.build(),
ReplicationSetRegionArgs.builder()
.name("ap-southeast-2")
.build())
.build());
}
}
resources:
replicationSetName:
type: aws:ssmincidents:ReplicationSet
properties:
regions:
- name: us-west-2
- name: ap-southeast-2
Delete a Region from a replication set. (You can delete only one Region at a time.)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const replicationSetName = new aws.ssmincidents.ReplicationSet("replicationSetName", {regions: [{
name: "us-west-2",
}]});
import pulumi
import pulumi_aws as aws
replication_set_name = aws.ssmincidents.ReplicationSet("replicationSetName", regions=[{
"name": "us-west-2",
}])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmincidents"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ssmincidents.NewReplicationSet(ctx, "replicationSetName", &ssmincidents.ReplicationSetArgs{
Regions: ssmincidents.ReplicationSetRegionArray{
&ssmincidents.ReplicationSetRegionArgs{
Name: pulumi.String("us-west-2"),
},
},
})
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 replicationSetName = new Aws.SsmIncidents.ReplicationSet("replicationSetName", new()
{
Regions = new[]
{
new Aws.SsmIncidents.Inputs.ReplicationSetRegionArgs
{
Name = "us-west-2",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssmincidents.ReplicationSet;
import com.pulumi.aws.ssmincidents.ReplicationSetArgs;
import com.pulumi.aws.ssmincidents.inputs.ReplicationSetRegionArgs;
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) {
var replicationSetName = new ReplicationSet("replicationSetName", ReplicationSetArgs.builder()
.regions(ReplicationSetRegionArgs.builder()
.name("us-west-2")
.build())
.build());
}
}
resources:
replicationSetName:
type: aws:ssmincidents:ReplicationSet
properties:
regions:
- name: us-west-2
Basic Usage with an AWS Customer Managed Key
Create a replication set with an AWS Key Management Service (AWS KMS) customer manager key:
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleKey = new aws.kms.Key("example_key", {});
const replicationSetName = new aws.ssmincidents.ReplicationSet("replicationSetName", {
regions: [{
name: "us-west-2",
kmsKeyArn: exampleKey.arn,
}],
tags: {
exampleTag: "exampleValue",
},
});
import pulumi
import pulumi_aws as aws
example_key = aws.kms.Key("example_key")
replication_set_name = aws.ssmincidents.ReplicationSet("replicationSetName",
regions=[{
"name": "us-west-2",
"kms_key_arn": example_key.arn,
}],
tags={
"exampleTag": "exampleValue",
})
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssmincidents"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleKey, err := kms.NewKey(ctx, "example_key", nil)
if err != nil {
return err
}
_, err = ssmincidents.NewReplicationSet(ctx, "replicationSetName", &ssmincidents.ReplicationSetArgs{
Regions: ssmincidents.ReplicationSetRegionArray{
&ssmincidents.ReplicationSetRegionArgs{
Name: pulumi.String("us-west-2"),
KmsKeyArn: exampleKey.Arn,
},
},
Tags: pulumi.StringMap{
"exampleTag": pulumi.String("exampleValue"),
},
})
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 exampleKey = new Aws.Kms.Key("example_key");
var replicationSetName = new Aws.SsmIncidents.ReplicationSet("replicationSetName", new()
{
Regions = new[]
{
new Aws.SsmIncidents.Inputs.ReplicationSetRegionArgs
{
Name = "us-west-2",
KmsKeyArn = exampleKey.Arn,
},
},
Tags =
{
{ "exampleTag", "exampleValue" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kms.Key;
import com.pulumi.aws.ssmincidents.ReplicationSet;
import com.pulumi.aws.ssmincidents.ReplicationSetArgs;
import com.pulumi.aws.ssmincidents.inputs.ReplicationSetRegionArgs;
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) {
var exampleKey = new Key("exampleKey");
var replicationSetName = new ReplicationSet("replicationSetName", ReplicationSetArgs.builder()
.regions(ReplicationSetRegionArgs.builder()
.name("us-west-2")
.kmsKeyArn(exampleKey.arn())
.build())
.tags(Map.of("exampleTag", "exampleValue"))
.build());
}
}
resources:
exampleKey:
type: aws:kms:Key
name: example_key
replicationSetName:
type: aws:ssmincidents:ReplicationSet
properties:
regions:
- name: us-west-2
kmsKeyArn: ${exampleKey.arn}
tags:
exampleTag: exampleValue
Create ReplicationSet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ReplicationSet(name: string, args: ReplicationSetArgs, opts?: CustomResourceOptions);
@overload
def ReplicationSet(resource_name: str,
args: ReplicationSetArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ReplicationSet(resource_name: str,
opts: Optional[ResourceOptions] = None,
regions: Optional[Sequence[ReplicationSetRegionArgs]] = None,
tags: Optional[Mapping[str, str]] = None)
func NewReplicationSet(ctx *Context, name string, args ReplicationSetArgs, opts ...ResourceOption) (*ReplicationSet, error)
public ReplicationSet(string name, ReplicationSetArgs args, CustomResourceOptions? opts = null)
public ReplicationSet(String name, ReplicationSetArgs args)
public ReplicationSet(String name, ReplicationSetArgs args, CustomResourceOptions options)
type: aws:ssmincidents:ReplicationSet
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 ReplicationSetArgs
- 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 ReplicationSetArgs
- 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 ReplicationSetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ReplicationSetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ReplicationSetArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var replicationSetResource = new Aws.SsmIncidents.ReplicationSet("replicationSetResource", new()
{
Regions = new[]
{
new Aws.SsmIncidents.Inputs.ReplicationSetRegionArgs
{
Name = "string",
KmsKeyArn = "string",
Status = "string",
StatusMessage = "string",
},
},
Tags =
{
{ "string", "string" },
},
});
example, err := ssmincidents.NewReplicationSet(ctx, "replicationSetResource", &ssmincidents.ReplicationSetArgs{
Regions: ssmincidents.ReplicationSetRegionArray{
&ssmincidents.ReplicationSetRegionArgs{
Name: pulumi.String("string"),
KmsKeyArn: pulumi.String("string"),
Status: pulumi.String("string"),
StatusMessage: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var replicationSetResource = new ReplicationSet("replicationSetResource", ReplicationSetArgs.builder()
.regions(ReplicationSetRegionArgs.builder()
.name("string")
.kmsKeyArn("string")
.status("string")
.statusMessage("string")
.build())
.tags(Map.of("string", "string"))
.build());
replication_set_resource = aws.ssmincidents.ReplicationSet("replicationSetResource",
regions=[{
"name": "string",
"kms_key_arn": "string",
"status": "string",
"status_message": "string",
}],
tags={
"string": "string",
})
const replicationSetResource = new aws.ssmincidents.ReplicationSet("replicationSetResource", {
regions: [{
name: "string",
kmsKeyArn: "string",
status: "string",
statusMessage: "string",
}],
tags: {
string: "string",
},
});
type: aws:ssmincidents:ReplicationSet
properties:
regions:
- kmsKeyArn: string
name: string
status: string
statusMessage: string
tags:
string: string
ReplicationSet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ReplicationSet resource accepts the following input properties:
- Regions
List<Replication
Set Region> - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- Dictionary<string, string>
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- Regions
[]Replication
Set Region Args - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- map[string]string
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- regions
List<Replication
Set Region> - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- Map<String,String>
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- regions
Replication
Set Region[] - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- {[key: string]: string}
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- regions
Sequence[Replication
Set Region Args] - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- Mapping[str, str]
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- regions List<Property Map>
- The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- Map<String>
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
Outputs
All input properties are implicitly available as output properties. Additionally, the ReplicationSet resource produces the following output properties:
- Arn string
- The ARN of the replication set.
- Created
By string - The ARN of the user who created the replication set.
- Deletion
Protected bool - If
true
, the last region in a replication set cannot be deleted. - Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringBy - A timestamp showing when the replication set was last modified.
- Status string
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- The ARN of the replication set.
- Created
By string - The ARN of the user who created the replication set.
- Deletion
Protected bool - If
true
, the last region in a replication set cannot be deleted. - Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringBy - A timestamp showing when the replication set was last modified.
- Status string
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The ARN of the replication set.
- created
By String - The ARN of the user who created the replication set.
- deletion
Protected Boolean - If
true
, the last region in a replication set cannot be deleted. - id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringBy - A timestamp showing when the replication set was last modified.
- status String
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- The ARN of the replication set.
- created
By string - The ARN of the user who created the replication set.
- deletion
Protected boolean - If
true
, the last region in a replication set cannot be deleted. - id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringBy - A timestamp showing when the replication set was last modified.
- status string
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- The ARN of the replication set.
- created_
by str - The ARN of the user who created the replication set.
- deletion_
protected bool - If
true
, the last region in a replication set cannot be deleted. - id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strby - A timestamp showing when the replication set was last modified.
- status str
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The ARN of the replication set.
- created
By String - The ARN of the user who created the replication set.
- deletion
Protected Boolean - If
true
, the last region in a replication set cannot be deleted. - id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringBy - A timestamp showing when the replication set was last modified.
- status String
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Look up Existing ReplicationSet Resource
Get an existing ReplicationSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ReplicationSetState, opts?: CustomResourceOptions): ReplicationSet
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
created_by: Optional[str] = None,
deletion_protected: Optional[bool] = None,
last_modified_by: Optional[str] = None,
regions: Optional[Sequence[ReplicationSetRegionArgs]] = None,
status: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> ReplicationSet
func GetReplicationSet(ctx *Context, name string, id IDInput, state *ReplicationSetState, opts ...ResourceOption) (*ReplicationSet, error)
public static ReplicationSet Get(string name, Input<string> id, ReplicationSetState? state, CustomResourceOptions? opts = null)
public static ReplicationSet get(String name, Output<String> id, ReplicationSetState state, CustomResourceOptions options)
resources: _: type: aws:ssmincidents:ReplicationSet get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The ARN of the replication set.
- Created
By string - The ARN of the user who created the replication set.
- Deletion
Protected bool - If
true
, the last region in a replication set cannot be deleted. - Last
Modified stringBy - A timestamp showing when the replication set was last modified.
- Regions
List<Replication
Set Region> - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- Status string
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Dictionary<string, string>
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
- The ARN of the replication set.
- Created
By string - The ARN of the user who created the replication set.
- Deletion
Protected bool - If
true
, the last region in a replication set cannot be deleted. - Last
Modified stringBy - A timestamp showing when the replication set was last modified.
- Regions
[]Replication
Set Region Args - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- Status string
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- map[string]string
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The ARN of the replication set.
- created
By String - The ARN of the user who created the replication set.
- deletion
Protected Boolean - If
true
, the last region in a replication set cannot be deleted. - last
Modified StringBy - A timestamp showing when the replication set was last modified.
- regions
List<Replication
Set Region> - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- status String
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Map<String,String>
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
- The ARN of the replication set.
- created
By string - The ARN of the user who created the replication set.
- deletion
Protected boolean - If
true
, the last region in a replication set cannot be deleted. - last
Modified stringBy - A timestamp showing when the replication set was last modified.
- regions
Replication
Set Region[] - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- status string
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- {[key: string]: string}
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
- The ARN of the replication set.
- created_
by str - The ARN of the user who created the replication set.
- deletion_
protected bool - If
true
, the last region in a replication set cannot be deleted. - last_
modified_ strby - A timestamp showing when the replication set was last modified.
- regions
Sequence[Replication
Set Region Args] - The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- status str
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Mapping[str, str]
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
- The ARN of the replication set.
- created
By String - The ARN of the user who created the replication set.
- deletion
Protected Boolean - If
true
, the last region in a replication set cannot be deleted. - last
Modified StringBy - A timestamp showing when the replication set was last modified.
- regions List<Property Map>
- The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
- status String
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Map<String>
Key-value map of resource tags. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.For information about the maximum allowed number of Regions and tag value constraints, see CreateReplicationSet in the AWS Systems Manager Incident Manager API Reference.
NOTE: The Region specified by a provider must always be one of the Regions specified for the replication set. This is especially important when you perform complex update operations.
NOTE: After a replication set is created, you can add or delete only one Region at a time.
NOTE: Incident Manager does not support updating the customer managed key associated with a replication set. Instead, for a replication set with multiple Regions, you must first delete a Region from the replication set, then re-add it with a different customer managed key in separate deploy operations. For a replication set with only one Region, the entire replication set must be deleted and recreated. To do this, comment out the replication set and all response plans, and then run the deploy command to recreate the replication set with the new customer managed key.
NOTE: You must either use AWS-owned keys on all regions of a replication set, or customer managed keys. To change between an AWS owned key and a customer managed key, a replication set and it associated data must be deleted and recreated.
NOTE: If possible, create all the customer managed keys you need (using the deploy command) before you create the replication set, or create the keys and replication set in the same deploy command. Otherwise, to delete a replication set, you must run one deploy command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Supporting Types
ReplicationSetRegion, ReplicationSetRegionArgs
- Name string
- The name of the Region, such as
ap-southeast-2
. - Kms
Key stringArn - The Amazon Resource name (ARN) of the customer managed key. If omitted, AWS manages the AWS KMS keys for you, using an AWS owned key, as indicated by a default value of
DefaultKey
. - Status string
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Status
Message string - More information about the status of a Region.
- Name string
- The name of the Region, such as
ap-southeast-2
. - Kms
Key stringArn - The Amazon Resource name (ARN) of the customer managed key. If omitted, AWS manages the AWS KMS keys for you, using an AWS owned key, as indicated by a default value of
DefaultKey
. - Status string
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- Status
Message string - More information about the status of a Region.
- name String
- The name of the Region, such as
ap-southeast-2
. - kms
Key StringArn - The Amazon Resource name (ARN) of the customer managed key. If omitted, AWS manages the AWS KMS keys for you, using an AWS owned key, as indicated by a default value of
DefaultKey
. - status String
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- status
Message String - More information about the status of a Region.
- name string
- The name of the Region, such as
ap-southeast-2
. - kms
Key stringArn - The Amazon Resource name (ARN) of the customer managed key. If omitted, AWS manages the AWS KMS keys for you, using an AWS owned key, as indicated by a default value of
DefaultKey
. - status string
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- status
Message string - More information about the status of a Region.
- name str
- The name of the Region, such as
ap-southeast-2
. - kms_
key_ strarn - The Amazon Resource name (ARN) of the customer managed key. If omitted, AWS manages the AWS KMS keys for you, using an AWS owned key, as indicated by a default value of
DefaultKey
. - status str
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- status_
message str - More information about the status of a Region.
- name String
- The name of the Region, such as
ap-southeast-2
. - kms
Key StringArn - The Amazon Resource name (ARN) of the customer managed key. If omitted, AWS manages the AWS KMS keys for you, using an AWS owned key, as indicated by a default value of
DefaultKey
. - status String
- The current status of the Region.
- Valid Values:
ACTIVE
|CREATING
|UPDATING
|DELETING
|FAILED
- Valid Values:
- status
Message String - More information about the status of a Region.
Import
Using pulumi import
, import an Incident Manager replication. For example:
$ pulumi import aws:ssmincidents/replicationSet:ReplicationSet replicationSetName import
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.