Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alicloud Provider
  3. API Docs
  4. resourcemanager
  5. Handshake
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.resourcemanager.Handshake

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a Resource Manager handshake resource. You can invite accounts to join a resource directory for unified management. For information about Resource Manager handshake and how to use it, see What is Resource Manager handshake.

    NOTE: Available in v1.82.0+.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

// Add a Resource Manager handshake.
const example = new alicloud.resourcemanager.Handshake("example", {
    targetEntity: "1182775234******",
    targetType: "Account",
    note: "test resource manager handshake",
});

    import pulumi
import pulumi_alicloud as alicloud

# Add a Resource Manager handshake.
example = alicloud.resourcemanager.Handshake("example",
    target_entity="1182775234******",
    target_type="Account",
    note="test resource manager handshake")

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Add a Resource Manager handshake.
		_, err := resourcemanager.NewHandshake(ctx, "example", &resourcemanager.HandshakeArgs{
			TargetEntity: pulumi.String("1182775234******"),
			TargetType:   pulumi.String("Account"),
			Note:         pulumi.String("test resource manager handshake"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    // Add a Resource Manager handshake.
    var example = new AliCloud.ResourceManager.Handshake("example", new()
    {
        TargetEntity = "1182775234******",
        TargetType = "Account",
        Note = "test resource manager handshake",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.Handshake;
import com.pulumi.alicloud.resourcemanager.HandshakeArgs;
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) {
        // Add a Resource Manager handshake.
        var example = new Handshake("example", HandshakeArgs.builder()
            .targetEntity("1182775234******")
            .targetType("Account")
            .note("test resource manager handshake")
            .build());

    }
}

    resources:
  # Add a Resource Manager handshake.
  example:
    type: alicloud:resourcemanager:Handshake
    properties:
      targetEntity: 1182775234******
      targetType: Account
      note: test resource manager handshake

    Create Handshake Resource

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

    Constructor syntax

    new Handshake(name: string, args: HandshakeArgs, opts?: CustomResourceOptions);
    @overload
def Handshake(resource_name: str,
              args: HandshakeArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Handshake(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              target_entity: Optional[str] = None,
              target_type: Optional[str] = None,
              note: Optional[str] = None)
    func NewHandshake(ctx *Context, name string, args HandshakeArgs, opts ...ResourceOption) (*Handshake, error)
    public Handshake(string name, HandshakeArgs args, CustomResourceOptions? opts = null)
    public Handshake(String name, HandshakeArgs args)
public Handshake(String name, HandshakeArgs args, CustomResourceOptions options)

    type: alicloud:resourcemanager:Handshake
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 HandshakeArgs
    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 HandshakeArgs
    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 HandshakeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HandshakeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HandshakeArgs
    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 handshakeResource = new AliCloud.ResourceManager.Handshake("handshakeResource", new()
{
    TargetEntity = "string",
    TargetType = "string",
    Note = "string",
});

    example, err := resourcemanager.NewHandshake(ctx, "handshakeResource", &resourcemanager.HandshakeArgs{
	TargetEntity: pulumi.String("string"),
	TargetType:   pulumi.String("string"),
	Note:         pulumi.String("string"),
})

    var handshakeResource = new Handshake("handshakeResource", HandshakeArgs.builder()
    .targetEntity("string")
    .targetType("string")
    .note("string")
    .build());

    handshake_resource = alicloud.resourcemanager.Handshake("handshakeResource",
    target_entity="string",
    target_type="string",
    note="string")

    const handshakeResource = new alicloud.resourcemanager.Handshake("handshakeResource", {
    targetEntity: "string",
    targetType: "string",
    note: "string",
});

    type: alicloud:resourcemanager:Handshake
properties:
    note: string
    targetEntity: string
    targetType: string

    Handshake 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 Handshake resource accepts the following input properties:

    TargetEntity string
    Invited account ID or login email.
    TargetType string
    Type of account being invited. Valid values: Account, Email.
    Note string
    Remarks. The maximum length is 1024 characters.
    TargetEntity string
    Invited account ID or login email.
    TargetType string
    Type of account being invited. Valid values: Account, Email.
    Note string
    Remarks. The maximum length is 1024 characters.
    targetEntity String
    Invited account ID or login email.
    targetType String
    Type of account being invited. Valid values: Account, Email.
    note String
    Remarks. The maximum length is 1024 characters.
    targetEntity string
    Invited account ID or login email.
    targetType string
    Type of account being invited. Valid values: Account, Email.
    note string
    Remarks. The maximum length is 1024 characters.
    target_entity str
    Invited account ID or login email.
    target_type str
    Type of account being invited. Valid values: Account, Email.
    note str
    Remarks. The maximum length is 1024 characters.
    targetEntity String
    Invited account ID or login email.
    targetType String
    Type of account being invited. Valid values: Account, Email.
    note String
    Remarks. The maximum length is 1024 characters.

    Outputs

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

    ExpireTime string
    The expiration time of the invitation.
    Id string
    The provider-assigned unique ID for this managed resource.
    MasterAccountId string
    Resource account master account ID.
    MasterAccountName string
    The name of the main account of the resource directory.
    ModifyTime string
    The modification time of the invitation.
    ResourceDirectoryId string
    Resource directory ID.
    Status string
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    ExpireTime string
    The expiration time of the invitation.
    Id string
    The provider-assigned unique ID for this managed resource.
    MasterAccountId string
    Resource account master account ID.
    MasterAccountName string
    The name of the main account of the resource directory.
    ModifyTime string
    The modification time of the invitation.
    ResourceDirectoryId string
    Resource directory ID.
    Status string
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    expireTime String
    The expiration time of the invitation.
    id String
    The provider-assigned unique ID for this managed resource.
    masterAccountId String
    Resource account master account ID.
    masterAccountName String
    The name of the main account of the resource directory.
    modifyTime String
    The modification time of the invitation.
    resourceDirectoryId String
    Resource directory ID.
    status String
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    expireTime string
    The expiration time of the invitation.
    id string
    The provider-assigned unique ID for this managed resource.
    masterAccountId string
    Resource account master account ID.
    masterAccountName string
    The name of the main account of the resource directory.
    modifyTime string
    The modification time of the invitation.
    resourceDirectoryId string
    Resource directory ID.
    status string
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    expire_time str
    The expiration time of the invitation.
    id str
    The provider-assigned unique ID for this managed resource.
    master_account_id str
    Resource account master account ID.
    master_account_name str
    The name of the main account of the resource directory.
    modify_time str
    The modification time of the invitation.
    resource_directory_id str
    Resource directory ID.
    status str
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    expireTime String
    The expiration time of the invitation.
    id String
    The provider-assigned unique ID for this managed resource.
    masterAccountId String
    Resource account master account ID.
    masterAccountName String
    The name of the main account of the resource directory.
    modifyTime String
    The modification time of the invitation.
    resourceDirectoryId String
    Resource directory ID.
    status String
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.

    Look up Existing Handshake Resource

    Get an existing Handshake 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?: HandshakeState, opts?: CustomResourceOptions): Handshake
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        expire_time: Optional[str] = None,
        master_account_id: Optional[str] = None,
        master_account_name: Optional[str] = None,
        modify_time: Optional[str] = None,
        note: Optional[str] = None,
        resource_directory_id: Optional[str] = None,
        status: Optional[str] = None,
        target_entity: Optional[str] = None,
        target_type: Optional[str] = None) -> Handshake
    func GetHandshake(ctx *Context, name string, id IDInput, state *HandshakeState, opts ...ResourceOption) (*Handshake, error)
    public static Handshake Get(string name, Input<string> id, HandshakeState? state, CustomResourceOptions? opts = null)
    public static Handshake get(String name, Output<String> id, HandshakeState 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:
    ExpireTime string
    The expiration time of the invitation.
    MasterAccountId string
    Resource account master account ID.
    MasterAccountName string
    The name of the main account of the resource directory.
    ModifyTime string
    The modification time of the invitation.
    Note string
    Remarks. The maximum length is 1024 characters.
    ResourceDirectoryId string
    Resource directory ID.
    Status string
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    TargetEntity string
    Invited account ID or login email.
    TargetType string
    Type of account being invited. Valid values: Account, Email.
    ExpireTime string
    The expiration time of the invitation.
    MasterAccountId string
    Resource account master account ID.
    MasterAccountName string
    The name of the main account of the resource directory.
    ModifyTime string
    The modification time of the invitation.
    Note string
    Remarks. The maximum length is 1024 characters.
    ResourceDirectoryId string
    Resource directory ID.
    Status string
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    TargetEntity string
    Invited account ID or login email.
    TargetType string
    Type of account being invited. Valid values: Account, Email.
    expireTime String
    The expiration time of the invitation.
    masterAccountId String
    Resource account master account ID.
    masterAccountName String
    The name of the main account of the resource directory.
    modifyTime String
    The modification time of the invitation.
    note String
    Remarks. The maximum length is 1024 characters.
    resourceDirectoryId String
    Resource directory ID.
    status String
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    targetEntity String
    Invited account ID or login email.
    targetType String
    Type of account being invited. Valid values: Account, Email.
    expireTime string
    The expiration time of the invitation.
    masterAccountId string
    Resource account master account ID.
    masterAccountName string
    The name of the main account of the resource directory.
    modifyTime string
    The modification time of the invitation.
    note string
    Remarks. The maximum length is 1024 characters.
    resourceDirectoryId string
    Resource directory ID.
    status string
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    targetEntity string
    Invited account ID or login email.
    targetType string
    Type of account being invited. Valid values: Account, Email.
    expire_time str
    The expiration time of the invitation.
    master_account_id str
    Resource account master account ID.
    master_account_name str
    The name of the main account of the resource directory.
    modify_time str
    The modification time of the invitation.
    note str
    Remarks. The maximum length is 1024 characters.
    resource_directory_id str
    Resource directory ID.
    status str
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    target_entity str
    Invited account ID or login email.
    target_type str
    Type of account being invited. Valid values: Account, Email.
    expireTime String
    The expiration time of the invitation.
    masterAccountId String
    Resource account master account ID.
    masterAccountName String
    The name of the main account of the resource directory.
    modifyTime String
    The modification time of the invitation.
    note String
    Remarks. The maximum length is 1024 characters.
    resourceDirectoryId String
    Resource directory ID.
    status String
    Invitation status. Valid values: Pending waiting for confirmation, Accepted, Cancelled, Declined, Expired.
    targetEntity String
    Invited account ID or login email.
    targetType String
    Type of account being invited. Valid values: Account, Email.

    Import

    Resource Manager handshake can be imported using the id, e.g.

    $ pulumi import alicloud:resourcemanager/handshake:Handshake example h-QmdexeFm1kE*****

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-alicloud