opentelekomcloud.CbrPolicyV3
Explore with Pulumi AI
Up-to-date reference of API arguments for CBR policy you can get at documentation portal
Manages a V3 CBR policy resource within OpenTelekomCloud.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const policy = new opentelekomcloud.CbrPolicyV3("policy", {
enabled: false,
operationDefinition: {
dayBackups: 1,
maxBackups: 10,
monthBackups: 4,
timezone: "UTC+03:00",
weekBackups: 2,
yearBackups: 3,
},
operationType: "backup",
triggerPatterns: ["FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00"],
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
policy = opentelekomcloud.CbrPolicyV3("policy",
enabled=False,
operation_definition={
"day_backups": 1,
"max_backups": 10,
"month_backups": 4,
"timezone": "UTC+03:00",
"week_backups": 2,
"year_backups": 3,
},
operation_type="backup",
trigger_patterns=["FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00"])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := opentelekomcloud.NewCbrPolicyV3(ctx, "policy", &opentelekomcloud.CbrPolicyV3Args{
Enabled: pulumi.Bool(false),
OperationDefinition: &opentelekomcloud.CbrPolicyV3OperationDefinitionArgs{
DayBackups: pulumi.Float64(1),
MaxBackups: pulumi.Float64(10),
MonthBackups: pulumi.Float64(4),
Timezone: pulumi.String("UTC+03:00"),
WeekBackups: pulumi.Float64(2),
YearBackups: pulumi.Float64(3),
},
OperationType: pulumi.String("backup"),
TriggerPatterns: pulumi.StringArray{
pulumi.String("FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var policy = new Opentelekomcloud.CbrPolicyV3("policy", new()
{
Enabled = false,
OperationDefinition = new Opentelekomcloud.Inputs.CbrPolicyV3OperationDefinitionArgs
{
DayBackups = 1,
MaxBackups = 10,
MonthBackups = 4,
Timezone = "UTC+03:00",
WeekBackups = 2,
YearBackups = 3,
},
OperationType = "backup",
TriggerPatterns = new[]
{
"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.CbrPolicyV3;
import com.pulumi.opentelekomcloud.CbrPolicyV3Args;
import com.pulumi.opentelekomcloud.inputs.CbrPolicyV3OperationDefinitionArgs;
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 policy = new CbrPolicyV3("policy", CbrPolicyV3Args.builder()
.enabled("false")
.operationDefinition(CbrPolicyV3OperationDefinitionArgs.builder()
.dayBackups(1)
.maxBackups(10)
.monthBackups(4)
.timezone("UTC+03:00")
.weekBackups(2)
.yearBackups(3)
.build())
.operationType("backup")
.triggerPatterns("FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00")
.build());
}
}
resources:
policy:
type: opentelekomcloud:CbrPolicyV3
properties:
enabled: 'false'
operationDefinition:
dayBackups: 1
maxBackups: 10
monthBackups: 4
timezone: UTC+03:00
weekBackups: 2
yearBackups: 3
operationType: backup
triggerPatterns:
- FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00
Create a replication policy (periodic backup)
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const config = new pulumi.Config();
const policyName = config.requireObject("policyName");
const destinationRegion = config.requireObject("destinationRegion");
const destinationProjectId = config.requireObject("destinationProjectId");
const policy = new opentelekomcloud.CbrPolicyV3("policy", {
operationType: "replication",
destinationRegion: destinationRegion,
destinationProjectId: destinationProjectId,
triggerPatterns: ["FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00"],
operationDefinition: {
dayBackups: 1,
weekBackups: 2,
yearBackups: 3,
monthBackups: 4,
maxBackups: 10,
timezone: "UTC+03:00",
},
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
config = pulumi.Config()
policy_name = config.require_object("policyName")
destination_region = config.require_object("destinationRegion")
destination_project_id = config.require_object("destinationProjectId")
policy = opentelekomcloud.CbrPolicyV3("policy",
operation_type="replication",
destination_region=destination_region,
destination_project_id=destination_project_id,
trigger_patterns=["FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00"],
operation_definition={
"day_backups": 1,
"week_backups": 2,
"year_backups": 3,
"month_backups": 4,
"max_backups": 10,
"timezone": "UTC+03:00",
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
policyName := cfg.RequireObject("policyName")
destinationRegion := cfg.RequireObject("destinationRegion")
destinationProjectId := cfg.RequireObject("destinationProjectId")
_, err := opentelekomcloud.NewCbrPolicyV3(ctx, "policy", &opentelekomcloud.CbrPolicyV3Args{
OperationType: pulumi.String("replication"),
DestinationRegion: pulumi.Any(destinationRegion),
DestinationProjectId: pulumi.Any(destinationProjectId),
TriggerPatterns: pulumi.StringArray{
pulumi.String("FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00"),
},
OperationDefinition: &opentelekomcloud.CbrPolicyV3OperationDefinitionArgs{
DayBackups: pulumi.Float64(1),
WeekBackups: pulumi.Float64(2),
YearBackups: pulumi.Float64(3),
MonthBackups: pulumi.Float64(4),
MaxBackups: pulumi.Float64(10),
Timezone: pulumi.String("UTC+03:00"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var policyName = config.RequireObject<dynamic>("policyName");
var destinationRegion = config.RequireObject<dynamic>("destinationRegion");
var destinationProjectId = config.RequireObject<dynamic>("destinationProjectId");
var policy = new Opentelekomcloud.CbrPolicyV3("policy", new()
{
OperationType = "replication",
DestinationRegion = destinationRegion,
DestinationProjectId = destinationProjectId,
TriggerPatterns = new[]
{
"FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00",
},
OperationDefinition = new Opentelekomcloud.Inputs.CbrPolicyV3OperationDefinitionArgs
{
DayBackups = 1,
WeekBackups = 2,
YearBackups = 3,
MonthBackups = 4,
MaxBackups = 10,
Timezone = "UTC+03:00",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.CbrPolicyV3;
import com.pulumi.opentelekomcloud.CbrPolicyV3Args;
import com.pulumi.opentelekomcloud.inputs.CbrPolicyV3OperationDefinitionArgs;
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) {
final var config = ctx.config();
final var policyName = config.get("policyName");
final var destinationRegion = config.get("destinationRegion");
final var destinationProjectId = config.get("destinationProjectId");
var policy = new CbrPolicyV3("policy", CbrPolicyV3Args.builder()
.operationType("replication")
.destinationRegion(destinationRegion)
.destinationProjectId(destinationProjectId)
.triggerPatterns("FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00")
.operationDefinition(CbrPolicyV3OperationDefinitionArgs.builder()
.dayBackups(1)
.weekBackups(2)
.yearBackups(3)
.monthBackups(4)
.maxBackups(10)
.timezone("UTC+03:00")
.build())
.build());
}
}
configuration:
policyName:
type: dynamic
destinationRegion:
type: dynamic
destinationProjectId:
type: dynamic
resources:
policy:
type: opentelekomcloud:CbrPolicyV3
properties:
operationType: replication
destinationRegion: ${destinationRegion}
destinationProjectId: ${destinationProjectId}
triggerPatterns:
- FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR,SA,SU;BYHOUR=14;BYMINUTE=00
operationDefinition:
dayBackups: 1
weekBackups: 2
yearBackups: 3
monthBackups: 4
maxBackups: 10
timezone: UTC+03:00
Create CbrPolicyV3 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CbrPolicyV3(name: string, args: CbrPolicyV3Args, opts?: CustomResourceOptions);
@overload
def CbrPolicyV3(resource_name: str,
args: CbrPolicyV3Args,
opts: Optional[ResourceOptions] = None)
@overload
def CbrPolicyV3(resource_name: str,
opts: Optional[ResourceOptions] = None,
operation_type: Optional[str] = None,
trigger_patterns: Optional[Sequence[str]] = None,
cbr_policy_v3_id: Optional[str] = None,
destination_project_id: Optional[str] = None,
destination_region: Optional[str] = None,
enabled: Optional[bool] = None,
name: Optional[str] = None,
operation_definition: Optional[CbrPolicyV3OperationDefinitionArgs] = None)
func NewCbrPolicyV3(ctx *Context, name string, args CbrPolicyV3Args, opts ...ResourceOption) (*CbrPolicyV3, error)
public CbrPolicyV3(string name, CbrPolicyV3Args args, CustomResourceOptions? opts = null)
public CbrPolicyV3(String name, CbrPolicyV3Args args)
public CbrPolicyV3(String name, CbrPolicyV3Args args, CustomResourceOptions options)
type: opentelekomcloud:CbrPolicyV3
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 CbrPolicyV3Args
- 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 CbrPolicyV3Args
- 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 CbrPolicyV3Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CbrPolicyV3Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CbrPolicyV3Args
- 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 cbrPolicyV3Resource = new Opentelekomcloud.CbrPolicyV3("cbrPolicyV3Resource", new()
{
OperationType = "string",
TriggerPatterns = new[]
{
"string",
},
CbrPolicyV3Id = "string",
DestinationProjectId = "string",
DestinationRegion = "string",
Enabled = false,
Name = "string",
OperationDefinition = new Opentelekomcloud.Inputs.CbrPolicyV3OperationDefinitionArgs
{
Timezone = "string",
DayBackups = 0,
MaxBackups = 0,
MonthBackups = 0,
RetentionDurationDays = 0,
WeekBackups = 0,
YearBackups = 0,
},
});
example, err := opentelekomcloud.NewCbrPolicyV3(ctx, "cbrPolicyV3Resource", &opentelekomcloud.CbrPolicyV3Args{
OperationType: pulumi.String("string"),
TriggerPatterns: pulumi.StringArray{
pulumi.String("string"),
},
CbrPolicyV3Id: pulumi.String("string"),
DestinationProjectId: pulumi.String("string"),
DestinationRegion: pulumi.String("string"),
Enabled: pulumi.Bool(false),
Name: pulumi.String("string"),
OperationDefinition: &opentelekomcloud.CbrPolicyV3OperationDefinitionArgs{
Timezone: pulumi.String("string"),
DayBackups: pulumi.Float64(0),
MaxBackups: pulumi.Float64(0),
MonthBackups: pulumi.Float64(0),
RetentionDurationDays: pulumi.Float64(0),
WeekBackups: pulumi.Float64(0),
YearBackups: pulumi.Float64(0),
},
})
var cbrPolicyV3Resource = new CbrPolicyV3("cbrPolicyV3Resource", CbrPolicyV3Args.builder()
.operationType("string")
.triggerPatterns("string")
.cbrPolicyV3Id("string")
.destinationProjectId("string")
.destinationRegion("string")
.enabled(false)
.name("string")
.operationDefinition(CbrPolicyV3OperationDefinitionArgs.builder()
.timezone("string")
.dayBackups(0)
.maxBackups(0)
.monthBackups(0)
.retentionDurationDays(0)
.weekBackups(0)
.yearBackups(0)
.build())
.build());
cbr_policy_v3_resource = opentelekomcloud.CbrPolicyV3("cbrPolicyV3Resource",
operation_type="string",
trigger_patterns=["string"],
cbr_policy_v3_id="string",
destination_project_id="string",
destination_region="string",
enabled=False,
name="string",
operation_definition={
"timezone": "string",
"day_backups": 0,
"max_backups": 0,
"month_backups": 0,
"retention_duration_days": 0,
"week_backups": 0,
"year_backups": 0,
})
const cbrPolicyV3Resource = new opentelekomcloud.CbrPolicyV3("cbrPolicyV3Resource", {
operationType: "string",
triggerPatterns: ["string"],
cbrPolicyV3Id: "string",
destinationProjectId: "string",
destinationRegion: "string",
enabled: false,
name: "string",
operationDefinition: {
timezone: "string",
dayBackups: 0,
maxBackups: 0,
monthBackups: 0,
retentionDurationDays: 0,
weekBackups: 0,
yearBackups: 0,
},
});
type: opentelekomcloud:CbrPolicyV3
properties:
cbrPolicyV3Id: string
destinationProjectId: string
destinationRegion: string
enabled: false
name: string
operationDefinition:
dayBackups: 0
maxBackups: 0
monthBackups: 0
retentionDurationDays: 0
timezone: string
weekBackups: 0
yearBackups: 0
operationType: string
triggerPatterns:
- string
CbrPolicyV3 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 CbrPolicyV3 resource accepts the following input properties:
- Operation
Type string - Policy type. Enumeration values:
backup
,replication
. - Trigger
Patterns List<string> Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:- Cbr
Policy stringV3Id - Destination
Project stringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - Destination
Region string - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - Enabled bool
- Whether to enable the policy. Default value is
true
. - Name string
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- Operation
Definition CbrPolicy V3Operation Definition - Scheduling parameter. See reference below.
- Operation
Type string - Policy type. Enumeration values:
backup
,replication
. - Trigger
Patterns []string Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:- Cbr
Policy stringV3Id - Destination
Project stringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - Destination
Region string - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - Enabled bool
- Whether to enable the policy. Default value is
true
. - Name string
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- Operation
Definition CbrPolicy V3Operation Definition Args - Scheduling parameter. See reference below.
- operation
Type String - Policy type. Enumeration values:
backup
,replication
. - trigger
Patterns List<String> Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:- cbr
Policy StringV3Id - destination
Project StringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - destination
Region String - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - enabled Boolean
- Whether to enable the policy. Default value is
true
. - name String
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- operation
Definition CbrPolicy V3Operation Definition - Scheduling parameter. See reference below.
- operation
Type string - Policy type. Enumeration values:
backup
,replication
. - trigger
Patterns string[] Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:- cbr
Policy stringV3Id - destination
Project stringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - destination
Region string - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - enabled boolean
- Whether to enable the policy. Default value is
true
. - name string
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- operation
Definition CbrPolicy V3Operation Definition - Scheduling parameter. See reference below.
- operation_
type str - Policy type. Enumeration values:
backup
,replication
. - trigger_
patterns Sequence[str] Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:- cbr_
policy_ strv3_ id - destination_
project_ strid - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - destination_
region str - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - enabled bool
- Whether to enable the policy. Default value is
true
. - name str
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- operation_
definition CbrPolicy V3Operation Definition Args - Scheduling parameter. See reference below.
- operation
Type String - Policy type. Enumeration values:
backup
,replication
. - trigger
Patterns List<String> Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:- cbr
Policy StringV3Id - destination
Project StringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - destination
Region String - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - enabled Boolean
- Whether to enable the policy. Default value is
true
. - name String
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- operation
Definition Property Map - Scheduling parameter. See reference below.
Outputs
All input properties are implicitly available as output properties. Additionally, the CbrPolicyV3 resource produces the following output properties:
Look up Existing CbrPolicyV3 Resource
Get an existing CbrPolicyV3 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?: CbrPolicyV3State, opts?: CustomResourceOptions): CbrPolicyV3
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cbr_policy_v3_id: Optional[str] = None,
destination_project_id: Optional[str] = None,
destination_region: Optional[str] = None,
enabled: Optional[bool] = None,
name: Optional[str] = None,
operation_definition: Optional[CbrPolicyV3OperationDefinitionArgs] = None,
operation_type: Optional[str] = None,
region: Optional[str] = None,
trigger_patterns: Optional[Sequence[str]] = None) -> CbrPolicyV3
func GetCbrPolicyV3(ctx *Context, name string, id IDInput, state *CbrPolicyV3State, opts ...ResourceOption) (*CbrPolicyV3, error)
public static CbrPolicyV3 Get(string name, Input<string> id, CbrPolicyV3State? state, CustomResourceOptions? opts = null)
public static CbrPolicyV3 get(String name, Output<String> id, CbrPolicyV3State state, CustomResourceOptions options)
resources: _: type: opentelekomcloud:CbrPolicyV3 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.
- Cbr
Policy stringV3Id - Destination
Project stringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - Destination
Region string - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - Enabled bool
- Whether to enable the policy. Default value is
true
. - Name string
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- Operation
Definition CbrPolicy V3Operation Definition - Scheduling parameter. See reference below.
- Operation
Type string - Policy type. Enumeration values:
backup
,replication
. - Region string
- Specifies the region of the CBRv3 policy.
- Trigger
Patterns List<string> Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:
- Cbr
Policy stringV3Id - Destination
Project stringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - Destination
Region string - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - Enabled bool
- Whether to enable the policy. Default value is
true
. - Name string
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- Operation
Definition CbrPolicy V3Operation Definition Args - Scheduling parameter. See reference below.
- Operation
Type string - Policy type. Enumeration values:
backup
,replication
. - Region string
- Specifies the region of the CBRv3 policy.
- Trigger
Patterns []string Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:
- cbr
Policy StringV3Id - destination
Project StringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - destination
Region String - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - enabled Boolean
- Whether to enable the policy. Default value is
true
. - name String
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- operation
Definition CbrPolicy V3Operation Definition - Scheduling parameter. See reference below.
- operation
Type String - Policy type. Enumeration values:
backup
,replication
. - region String
- Specifies the region of the CBRv3 policy.
- trigger
Patterns List<String> Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:
- cbr
Policy stringV3Id - destination
Project stringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - destination
Region string - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - enabled boolean
- Whether to enable the policy. Default value is
true
. - name string
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- operation
Definition CbrPolicy V3Operation Definition - Scheduling parameter. See reference below.
- operation
Type string - Policy type. Enumeration values:
backup
,replication
. - region string
- Specifies the region of the CBRv3 policy.
- trigger
Patterns string[] Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:
- cbr_
policy_ strv3_ id - destination_
project_ strid - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - destination_
region str - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - enabled bool
- Whether to enable the policy. Default value is
true
. - name str
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- operation_
definition CbrPolicy V3Operation Definition Args - Scheduling parameter. See reference below.
- operation_
type str - Policy type. Enumeration values:
backup
,replication
. - region str
- Specifies the region of the CBRv3 policy.
- trigger_
patterns Sequence[str] Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:
- cbr
Policy StringV3Id - destination
Project StringId - Specifies the ID of the replication destination project, which is
mandatory for cross-region replication. Required if
operation_type
isreplication
. - destination
Region String - Specifies the name of the replication destination region, which is mandatory
for cross-region replication. Required if
operation_type
isreplication
. - enabled Boolean
- Whether to enable the policy. Default value is
true
. - name String
- Specifies the policy name. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-).
- operation
Definition Property Map - Scheduling parameter. See reference below.
- operation
Type String - Policy type. Enumeration values:
backup
,replication
. - region String
- Specifies the region of the CBRv3 policy.
- trigger
Patterns List<String> Scheduling rule. In the replication policy, you are advised to set one time point for one day. A maximum of 24 rules can be configured. The scheduling rule complies with iCalendar RFC 2445, but it supports only parameters
FREQ
,BYDAY
,BYHOUR
,BYMINUTE
, andINTERVAL
.FREQ
can be set only toWEEKLY
andDAILY
.The
operation_definition
block contains:
Supporting Types
CbrPolicyV3OperationDefinition, CbrPolicyV3OperationDefinitionArgs
- Timezone string
- Time zone where the user is located, for example,
UTC+00:00
. - Day
Backups double - Specifies the number of retained daily backups. The latest
backup of each day is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - Max
Backups double - Maximum number of retained backups. The value can be
-1
or ranges from0
to99999
. If the value is set to-1
, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter andretention_duration_days
are both left blank, the backups will be retained permanently. - Month
Backups double - Specifies the number of retained monthly backups. The latest
backup of each month is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - Retention
Duration doubleDays - Duration of retaining a backup, in days.
The maximum value is
99999
.-1
indicates that the backups will not be cleared based on the retention duration. If this parameter andmax_backups
are left blank at the same time, the backups will be retained permanently. - Week
Backups double - Specifies the number of retained weekly backups. The latest
backup of each week is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - Year
Backups double - Specifies the number of retained yearly backups. The latest
backup of each year is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory.
- Timezone string
- Time zone where the user is located, for example,
UTC+00:00
. - Day
Backups float64 - Specifies the number of retained daily backups. The latest
backup of each day is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - Max
Backups float64 - Maximum number of retained backups. The value can be
-1
or ranges from0
to99999
. If the value is set to-1
, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter andretention_duration_days
are both left blank, the backups will be retained permanently. - Month
Backups float64 - Specifies the number of retained monthly backups. The latest
backup of each month is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - Retention
Duration float64Days - Duration of retaining a backup, in days.
The maximum value is
99999
.-1
indicates that the backups will not be cleared based on the retention duration. If this parameter andmax_backups
are left blank at the same time, the backups will be retained permanently. - Week
Backups float64 - Specifies the number of retained weekly backups. The latest
backup of each week is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - Year
Backups float64 - Specifies the number of retained yearly backups. The latest
backup of each year is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory.
- timezone String
- Time zone where the user is located, for example,
UTC+00:00
. - day
Backups Double - Specifies the number of retained daily backups. The latest
backup of each day is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - max
Backups Double - Maximum number of retained backups. The value can be
-1
or ranges from0
to99999
. If the value is set to-1
, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter andretention_duration_days
are both left blank, the backups will be retained permanently. - month
Backups Double - Specifies the number of retained monthly backups. The latest
backup of each month is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - retention
Duration DoubleDays - Duration of retaining a backup, in days.
The maximum value is
99999
.-1
indicates that the backups will not be cleared based on the retention duration. If this parameter andmax_backups
are left blank at the same time, the backups will be retained permanently. - week
Backups Double - Specifies the number of retained weekly backups. The latest
backup of each week is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - year
Backups Double - Specifies the number of retained yearly backups. The latest
backup of each year is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory.
- timezone string
- Time zone where the user is located, for example,
UTC+00:00
. - day
Backups number - Specifies the number of retained daily backups. The latest
backup of each day is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - max
Backups number - Maximum number of retained backups. The value can be
-1
or ranges from0
to99999
. If the value is set to-1
, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter andretention_duration_days
are both left blank, the backups will be retained permanently. - month
Backups number - Specifies the number of retained monthly backups. The latest
backup of each month is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - retention
Duration numberDays - Duration of retaining a backup, in days.
The maximum value is
99999
.-1
indicates that the backups will not be cleared based on the retention duration. If this parameter andmax_backups
are left blank at the same time, the backups will be retained permanently. - week
Backups number - Specifies the number of retained weekly backups. The latest
backup of each week is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - year
Backups number - Specifies the number of retained yearly backups. The latest
backup of each year is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory.
- timezone str
- Time zone where the user is located, for example,
UTC+00:00
. - day_
backups float - Specifies the number of retained daily backups. The latest
backup of each day is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - max_
backups float - Maximum number of retained backups. The value can be
-1
or ranges from0
to99999
. If the value is set to-1
, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter andretention_duration_days
are both left blank, the backups will be retained permanently. - month_
backups float - Specifies the number of retained monthly backups. The latest
backup of each month is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - retention_
duration_ floatdays - Duration of retaining a backup, in days.
The maximum value is
99999
.-1
indicates that the backups will not be cleared based on the retention duration. If this parameter andmax_backups
are left blank at the same time, the backups will be retained permanently. - week_
backups float - Specifies the number of retained weekly backups. The latest
backup of each week is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - year_
backups float - Specifies the number of retained yearly backups. The latest
backup of each year is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory.
- timezone String
- Time zone where the user is located, for example,
UTC+00:00
. - day
Backups Number - Specifies the number of retained daily backups. The latest
backup of each day is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - max
Backups Number - Maximum number of retained backups. The value can be
-1
or ranges from0
to99999
. If the value is set to-1
, the backups will not be cleared even though the configured retained backup quantity is exceeded. If this parameter andretention_duration_days
are both left blank, the backups will be retained permanently. - month
Backups Number - Specifies the number of retained monthly backups. The latest
backup of each month is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - retention
Duration NumberDays - Duration of retaining a backup, in days.
The maximum value is
99999
.-1
indicates that the backups will not be cleared based on the retention duration. If this parameter andmax_backups
are left blank at the same time, the backups will be retained permanently. - week
Backups Number - Specifies the number of retained weekly backups. The latest
backup of each week is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory. - year
Backups Number - Specifies the number of retained yearly backups. The latest
backup of each year is saved in the long term. This parameter can be effective together
with the maximum number of retained backups specified by
max_backups
. The value ranges from0
to100
. If this parameter is configured,timezone
is mandatory.
Import
Volumes can be imported using the id
, e.g.
$ pulumi import opentelekomcloud:index/cbrPolicyV3:CbrPolicyV3 policy ea257959-eeb1-4c10-8d33-26f0409a766a
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
- License
- Notes
- This Pulumi package is based on the
opentelekomcloud
Terraform Provider.