interface ReplicaProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Synthetics.CfnCanary.ReplicaProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssynthetics#CfnCanary_ReplicaProperty`
Java	`software.amazon.awscdk.services.synthetics.CfnCanary.ReplicaProperty`
Python	`aws_cdk.aws_synthetics.CfnCanary.ReplicaProperty`
TypeScript	`aws-cdk-lib` » `aws_synthetics` » `CfnCanary` » `ReplicaProperty`

Configuration and status for a replica location in a multi-location canary.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-replica.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_synthetics as synthetics } from 'aws-cdk-lib';
const replicaProperty: synthetics.CfnCanary.ReplicaProperty = {
  location: 'location',

  // the properties below are optional
  canaryState: 'canaryState',
  kmsKeyArn: 'kmsKeyArn',
  lastModified: 123,
  replicationStatus: {
    state: 'state',
  },
  resourcesToReplicateTags: ['resourcesToReplicateTags'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcConfig: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],

    // the properties below are optional
    ipv6AllowedForDualStack: false,
    vpcId: 'vpcId',
  },
};

Properties

Name	Type	Description
location	`string`	AWS region for the replica (e.g., us-east-1).
canaryState?	`string`	State of the replica canary (CREATING, READY, RUNNING, etc.).
kmsKeyArn?	`string`	ARN of the KMS key used to encrypt the replica canary's Lambda function environment variables.
lastModified?	`number`	Last modified timestamp of the replica.
replicationStatus?	`IResolvable` `\|` `ReplicaReplicationStatusProperty`	Replication status details.
resourcesToReplicateTags?	`string[]`	Resources to replicate tags to for this replica (e.g., lambda-function).
tags?	`CfnTag[]`	Tags to apply to this replica canary and optionally its Lambda function.
vpcConfig?	`IResolvable` `\|` `VPCConfigProperty`