1. Packages
  2. Volcengine
  3. API Docs
  4. financial_relation
  5. FinancialRelation
Volcengine v0.0.25 published on Tuesday, Jul 2, 2024 by Volcengine

volcengine.financial_relation.FinancialRelation

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.25 published on Tuesday, Jul 2, 2024 by Volcengine

    Provides a resource to manage financial relation

    Create FinancialRelation Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FinancialRelation(name: string, args: FinancialRelationArgs, opts?: CustomResourceOptions);
    @overload
    def FinancialRelation(resource_name: str,
                          args: FinancialRelationArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def FinancialRelation(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          sub_account_id: Optional[int] = None,
                          account_alias: Optional[str] = None,
                          auth_lists: Optional[Sequence[int]] = None,
                          relation: Optional[int] = None)
    func NewFinancialRelation(ctx *Context, name string, args FinancialRelationArgs, opts ...ResourceOption) (*FinancialRelation, error)
    public FinancialRelation(string name, FinancialRelationArgs args, CustomResourceOptions? opts = null)
    public FinancialRelation(String name, FinancialRelationArgs args)
    public FinancialRelation(String name, FinancialRelationArgs args, CustomResourceOptions options)
    
    type: volcengine:financial_relation:FinancialRelation
    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 FinancialRelationArgs
    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 FinancialRelationArgs
    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 FinancialRelationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FinancialRelationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FinancialRelationArgs
    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 financialRelationResource = new Volcengine.Financial_relation.FinancialRelation("financialRelationResource", new()
    {
        SubAccountId = 0,
        AccountAlias = "string",
        AuthLists = new[]
        {
            0,
        },
        Relation = 0,
    });
    
    example, err := financial_relation.NewFinancialRelation(ctx, "financialRelationResource", &financial_relation.FinancialRelationArgs{
    	SubAccountId: pulumi.Int(0),
    	AccountAlias: pulumi.String("string"),
    	AuthLists: pulumi.IntArray{
    		pulumi.Int(0),
    	},
    	Relation: pulumi.Int(0),
    })
    
    var financialRelationResource = new FinancialRelation("financialRelationResource", FinancialRelationArgs.builder()
        .subAccountId(0)
        .accountAlias("string")
        .authLists(0)
        .relation(0)
        .build());
    
    financial_relation_resource = volcengine.financial_relation.FinancialRelation("financialRelationResource",
        sub_account_id=0,
        account_alias="string",
        auth_lists=[0],
        relation=0)
    
    const financialRelationResource = new volcengine.financial_relation.FinancialRelation("financialRelationResource", {
        subAccountId: 0,
        accountAlias: "string",
        authLists: [0],
        relation: 0,
    });
    
    type: volcengine:financial_relation:FinancialRelation
    properties:
        accountAlias: string
        authLists:
            - 0
        relation: 0
        subAccountId: 0
    

    FinancialRelation Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The FinancialRelation resource accepts the following input properties:

    SubAccountId int
    The sub account id.
    AccountAlias string
    The display name of the sub account.
    AuthLists List<int>
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    Relation int
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    SubAccountId int
    The sub account id.
    AccountAlias string
    The display name of the sub account.
    AuthLists []int
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    Relation int
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    subAccountId Integer
    The sub account id.
    accountAlias String
    The display name of the sub account.
    authLists List<Integer>
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    relation Integer
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    subAccountId number
    The sub account id.
    accountAlias string
    The display name of the sub account.
    authLists number[]
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    relation number
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    sub_account_id int
    The sub account id.
    account_alias str
    The display name of the sub account.
    auth_lists Sequence[int]
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    relation int
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    subAccountId Number
    The sub account id.
    accountAlias String
    The display name of the sub account.
    authLists List<Number>
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    relation Number
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FinancialRelation resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RelationId string
    The id of the financial relation.
    Status int
    The status of the financial relation.
    Id string
    The provider-assigned unique ID for this managed resource.
    RelationId string
    The id of the financial relation.
    Status int
    The status of the financial relation.
    id String
    The provider-assigned unique ID for this managed resource.
    relationId String
    The id of the financial relation.
    status Integer
    The status of the financial relation.
    id string
    The provider-assigned unique ID for this managed resource.
    relationId string
    The id of the financial relation.
    status number
    The status of the financial relation.
    id str
    The provider-assigned unique ID for this managed resource.
    relation_id str
    The id of the financial relation.
    status int
    The status of the financial relation.
    id String
    The provider-assigned unique ID for this managed resource.
    relationId String
    The id of the financial relation.
    status Number
    The status of the financial relation.

    Look up Existing FinancialRelation Resource

    Get an existing FinancialRelation 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?: FinancialRelationState, opts?: CustomResourceOptions): FinancialRelation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_alias: Optional[str] = None,
            auth_lists: Optional[Sequence[int]] = None,
            relation: Optional[int] = None,
            relation_id: Optional[str] = None,
            status: Optional[int] = None,
            sub_account_id: Optional[int] = None) -> FinancialRelation
    func GetFinancialRelation(ctx *Context, name string, id IDInput, state *FinancialRelationState, opts ...ResourceOption) (*FinancialRelation, error)
    public static FinancialRelation Get(string name, Input<string> id, FinancialRelationState? state, CustomResourceOptions? opts = null)
    public static FinancialRelation get(String name, Output<String> id, FinancialRelationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    The following state arguments are supported:
    AccountAlias string
    The display name of the sub account.
    AuthLists List<int>
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    Relation int
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    RelationId string
    The id of the financial relation.
    Status int
    The status of the financial relation.
    SubAccountId int
    The sub account id.
    AccountAlias string
    The display name of the sub account.
    AuthLists []int
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    Relation int
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    RelationId string
    The id of the financial relation.
    Status int
    The status of the financial relation.
    SubAccountId int
    The sub account id.
    accountAlias String
    The display name of the sub account.
    authLists List<Integer>
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    relation Integer
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    relationId String
    The id of the financial relation.
    status Integer
    The status of the financial relation.
    subAccountId Integer
    The sub account id.
    accountAlias string
    The display name of the sub account.
    authLists number[]
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    relation number
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    relationId string
    The id of the financial relation.
    status number
    The status of the financial relation.
    subAccountId number
    The sub account id.
    account_alias str
    The display name of the sub account.
    auth_lists Sequence[int]
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    relation int
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    relation_id str
    The id of the financial relation.
    status int
    The status of the financial relation.
    sub_account_id int
    The sub account id.
    accountAlias String
    The display name of the sub account.
    authLists List<Number>
    The authorization list of financial management. This field is valid and required when the relation is 4. Valid value range is 1-5.
    relation Number
    The relation of the financial. Valid values: 1, 4. 1 means financial custody, 4 means financial management.
    relationId String
    The id of the financial relation.
    status Number
    The status of the financial relation.
    subAccountId Number
    The sub account id.

    Import

    FinancialRelation can be imported using the sub_account_id:relation:relation_id, e.g.

     $ pulumi import volcengine:financial_relation/financialRelation:FinancialRelation default resource_id
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.25 published on Tuesday, Jul 2, 2024 by Volcengine