Control how Arpio protects and recovers your AWS resources by setting "configuration tags" on resources in your primary environment.
You can control how Arpio protects and recovers your AWS resources by setting configuration tags on resources in your primary environment.
Configuration tags are tags you set using AWS's normal tagging APIs or through the AWS management console. Arpio reads these tags when it creates recovery points, and uses the tag values as they were when the recovery point was created to control how resources are recovered when you test and fail over your applications.
Arpio configuration tags are normal AWS tags, which means they have a textual name and an optional textual value. All configuration tags have a name that starts with "arpio-config:", but the format of the rest of the tag name varies with the type of the configuration tag and resource type it's being applied to. The value is always specific to the configuration tag type and resource type.
Arpio only reads and follows configuration tags that are set on resources in your primary environment. If you set configuration tags on resources in your recovery environment, Arpio ignores them when it manages those resources (and it may overwrite them there).
If you use an incorrect key format in your configuration tags, Arpio generally ignores the tag. If you use an incorrect value format, Arpio generally tells you about the problem, so you can fix it promptly. Test your applications regularly to ensure your configuration tags are working as you expect. You can verify the recovery environment configuration using the AWS management console or APIs.
Supported Arpio Configuration Tags
-
arpio-config:amazon-side-asn - override the ASN that Arpio will apply to a recovered transit gateway
-
arpio-config:application:environment: - set or override variables inside recovered Elastic Beanstalk environments
- arpio-config:availability-zone - direct a subnet to be recovered in a specific availability zone in your recovery region
- arpio-config:db-instance-class - override the DB instance class used to recover an RDS DB instance
- arpio-config:depends-on: - control the order in which Arpio recovers your resources
- arpio-config:domain-name-servers - Override the DNS settings on a DHCP Options Group
- arpio-config:drs-device-name - override a device name when managing recovery with real-time replication and DRS
- arpio-config:environment: - set or override environment variables in recovered resources
- arpio-config:fsx:ad:FileSystemAdministratorsGroup - Use a custom value for FileSystemAdministratorsGroup when an FSx for Windows file system is recovered
- arpio-config:fsx:ad:OrganizationalUnitDistinguishedName - Use a custom value for OrganizationalUnitDistinguishedName when an FSx for Windows file system is recoverd
- arpio-config:hosted-zone-vpc-ids - indicate which VPCs reference a Route 53 Public Hosted Zone in the primary environment
- arpio-config:ignore - prevent resources from being shown in the Arpio console and being included in recovery points
- arpio-config:include - discover a source resource that is not automatically being discovered by Arpio
- arpio-config:opensearch-indexes - define OpenSearch indices to include or exclude in a recovery
- arpio-config:recovery-resource - specify a recovery resource to use when Arpio can't create or determine the recovery resource
- arpio-config:recovery-value - specify a value to use in the recovery environment
- arpio-config:renumber: - map a VPC's IPv4 CIDR block to a different IPv4 CIDR block in the recovery environment
- arpio-config:self-managed - specify that the recovered resource's contents or value should be created empty, and not be changed by Arpio
- arpio-config:snapshot-location - configure the location of customer-managed Redis snapshots that Arpio should use to seed a recovered ElastiCache cluster
- arpio-config:stream:BatchSize - Configure the maximum number of items sent in a batch to the Arpio DynamoDB replication function
- arpio-config:stream:MaximumBatchingWindowInSeconds - Configure the batching window duration for the Arpio DynamoDB replication function
- arpio-config:stream:ParallelizationFactor - Configure the maximum number of items processed concurrently by the Arpio DynamoDB replication function
- arpio-config:tag: - set or override tags on recovered resources
- arpio-config:translate-id: Specify a resource type to replace the SSM Parameter value with the corresponding translated resource identifier