Interface CfnCanary.ReplicaProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnCanary.ReplicaProperty.Jsii$Proxy
- Enclosing class:
CfnCanary
@Stability(Stable)
public static interface CfnCanary.ReplicaProperty
extends software.amazon.jsii.JsiiSerializable
Configuration and status for a replica location in a multi-location canary.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.synthetics.*;
ReplicaProperty replicaProperty = ReplicaProperty.builder()
.location("location")
// the properties below are optional
.canaryState("canaryState")
.kmsKeyArn("kmsKeyArn")
.lastModified(123)
.replicationStatus(ReplicaReplicationStatusProperty.builder()
.state("state")
.build())
.resourcesToReplicateTags(List.of("resourcesToReplicateTags"))
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.vpcConfig(VPCConfigProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
// the properties below are optional
.ipv6AllowedForDualStack(false)
.vpcId("vpcId")
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnCanary.ReplicaPropertystatic final classAn implementation forCfnCanary.ReplicaProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringState of the replica canary (CREATING, READY, RUNNING, etc.).default StringARN of the KMS key used to encrypt the replica canary's Lambda function environment variables.default NumberLast modified timestamp of the replica.AWS region for the replica (e.g., us-east-1).default ObjectReplication status details.Resources to replicate tags to for this replica (e.g., lambda-function).getTags()Tags to apply to this replica canary and optionally its Lambda function.default ObjectReturns union: eitherIResolvableorCfnCanary.VPCConfigPropertyMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getLocation
AWS region for the replica (e.g., us-east-1).- See Also:
-
getCanaryState
State of the replica canary (CREATING, READY, RUNNING, etc.).- See Also:
-
getKmsKeyArn
ARN of the KMS key used to encrypt the replica canary's Lambda function environment variables.- See Also:
-
getLastModified
Last modified timestamp of the replica.- See Also:
-
getReplicationStatus
Replication status details.Returns union: either
IResolvableorCfnCanary.ReplicaReplicationStatusProperty- See Also:
-
getResourcesToReplicateTags
Resources to replicate tags to for this replica (e.g., lambda-function).- See Also:
-
getTags
Tags to apply to this replica canary and optionally its Lambda function.- See Also:
-
getVpcConfig
Returns union: eitherIResolvableorCfnCanary.VPCConfigProperty- See Also:
-
builder
- Returns:
- a
CfnCanary.ReplicaProperty.BuilderofCfnCanary.ReplicaProperty
-