Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. bastionhost
  5. HostShareKey
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.bastionhost.HostShareKey

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a Bastion Host Share Key resource.

    For information about Bastion Host Host Share Key and how to use it, see What is Host Share Key.

    NOTE: Available since v1.165.0.

    Create HostShareKey Resource

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

    Constructor syntax

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

@overload
def HostShareKey(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 host_share_key_name: Optional[str] = None,
                 instance_id: Optional[str] = None,
                 private_key: Optional[str] = None,
                 pass_phrase: Optional[str] = None)
    func NewHostShareKey(ctx *Context, name string, args HostShareKeyArgs, opts ...ResourceOption) (*HostShareKey, error)
    public HostShareKey(string name, HostShareKeyArgs args, CustomResourceOptions? opts = null)
    public HostShareKey(String name, HostShareKeyArgs args)
public HostShareKey(String name, HostShareKeyArgs args, CustomResourceOptions options)

    type: alicloud:bastionhost:HostShareKey
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 HostShareKeyArgs
    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 HostShareKeyArgs
    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 HostShareKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args HostShareKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args HostShareKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var hostShareKeyResource = new AliCloud.BastionHost.HostShareKey("hostShareKeyResource", new()
{
    HostShareKeyName = "string",
    InstanceId = "string",
    PrivateKey = "string",
    PassPhrase = "string",
});

    example, err := bastionhost.NewHostShareKey(ctx, "hostShareKeyResource", &bastionhost.HostShareKeyArgs{
	HostShareKeyName: pulumi.String("string"),
	InstanceId:       pulumi.String("string"),
	PrivateKey:       pulumi.String("string"),
	PassPhrase:       pulumi.String("string"),
})

    var hostShareKeyResource = new HostShareKey("hostShareKeyResource", HostShareKeyArgs.builder()        
    .hostShareKeyName("string")
    .instanceId("string")
    .privateKey("string")
    .passPhrase("string")
    .build());

    host_share_key_resource = alicloud.bastionhost.HostShareKey("hostShareKeyResource",
    host_share_key_name="string",
    instance_id="string",
    private_key="string",
    pass_phrase="string")

    const hostShareKeyResource = new alicloud.bastionhost.HostShareKey("hostShareKeyResource", {
    hostShareKeyName: "string",
    instanceId: "string",
    privateKey: "string",
    passPhrase: "string",
});

    type: alicloud:bastionhost:HostShareKey
properties:
    hostShareKeyName: string
    instanceId: string
    passPhrase: string
    privateKey: string

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

    HostShareKeyName string
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    InstanceId string
    The ID of the Bastion instance.
    PrivateKey string
    The private key. The value is a Base64-encoded string.
    PassPhrase string
    The password of the private key. The value is a Base64-encoded string.
    HostShareKeyName string
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    InstanceId string
    The ID of the Bastion instance.
    PrivateKey string
    The private key. The value is a Base64-encoded string.
    PassPhrase string
    The password of the private key. The value is a Base64-encoded string.
    hostShareKeyName String
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    instanceId String
    The ID of the Bastion instance.
    privateKey String
    The private key. The value is a Base64-encoded string.
    passPhrase String
    The password of the private key. The value is a Base64-encoded string.
    hostShareKeyName string
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    instanceId string
    The ID of the Bastion instance.
    privateKey string
    The private key. The value is a Base64-encoded string.
    passPhrase string
    The password of the private key. The value is a Base64-encoded string.
    host_share_key_name str
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    instance_id str
    The ID of the Bastion instance.
    private_key str
    The private key. The value is a Base64-encoded string.
    pass_phrase str
    The password of the private key. The value is a Base64-encoded string.
    hostShareKeyName String
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    instanceId String
    The ID of the Bastion instance.
    privateKey String
    The private key. The value is a Base64-encoded string.
    passPhrase String
    The password of the private key. The value is a Base64-encoded string.

    Outputs

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

    HostShareKeyId string
    The first ID of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateKeyFingerPrint string
    The fingerprint of the private key.
    HostShareKeyId string
    The first ID of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateKeyFingerPrint string
    The fingerprint of the private key.
    hostShareKeyId String
    The first ID of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    privateKeyFingerPrint String
    The fingerprint of the private key.
    hostShareKeyId string
    The first ID of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    privateKeyFingerPrint string
    The fingerprint of the private key.
    host_share_key_id str
    The first ID of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    private_key_finger_print str
    The fingerprint of the private key.
    hostShareKeyId String
    The first ID of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    privateKeyFingerPrint String
    The fingerprint of the private key.

    Look up Existing HostShareKey Resource

    Get an existing HostShareKey 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?: HostShareKeyState, opts?: CustomResourceOptions): HostShareKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        host_share_key_id: Optional[str] = None,
        host_share_key_name: Optional[str] = None,
        instance_id: Optional[str] = None,
        pass_phrase: Optional[str] = None,
        private_key: Optional[str] = None,
        private_key_finger_print: Optional[str] = None) -> HostShareKey
    func GetHostShareKey(ctx *Context, name string, id IDInput, state *HostShareKeyState, opts ...ResourceOption) (*HostShareKey, error)
    public static HostShareKey Get(string name, Input<string> id, HostShareKeyState? state, CustomResourceOptions? opts = null)
    public static HostShareKey get(String name, Output<String> id, HostShareKeyState 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:
    HostShareKeyId string
    The first ID of the resource.
    HostShareKeyName string
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    InstanceId string
    The ID of the Bastion instance.
    PassPhrase string
    The password of the private key. The value is a Base64-encoded string.
    PrivateKey string
    The private key. The value is a Base64-encoded string.
    PrivateKeyFingerPrint string
    The fingerprint of the private key.
    HostShareKeyId string
    The first ID of the resource.
    HostShareKeyName string
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    InstanceId string
    The ID of the Bastion instance.
    PassPhrase string
    The password of the private key. The value is a Base64-encoded string.
    PrivateKey string
    The private key. The value is a Base64-encoded string.
    PrivateKeyFingerPrint string
    The fingerprint of the private key.
    hostShareKeyId String
    The first ID of the resource.
    hostShareKeyName String
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    instanceId String
    The ID of the Bastion instance.
    passPhrase String
    The password of the private key. The value is a Base64-encoded string.
    privateKey String
    The private key. The value is a Base64-encoded string.
    privateKeyFingerPrint String
    The fingerprint of the private key.
    hostShareKeyId string
    The first ID of the resource.
    hostShareKeyName string
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    instanceId string
    The ID of the Bastion instance.
    passPhrase string
    The password of the private key. The value is a Base64-encoded string.
    privateKey string
    The private key. The value is a Base64-encoded string.
    privateKeyFingerPrint string
    The fingerprint of the private key.
    host_share_key_id str
    The first ID of the resource.
    host_share_key_name str
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    instance_id str
    The ID of the Bastion instance.
    pass_phrase str
    The password of the private key. The value is a Base64-encoded string.
    private_key str
    The private key. The value is a Base64-encoded string.
    private_key_finger_print str
    The fingerprint of the private key.
    hostShareKeyId String
    The first ID of the resource.
    hostShareKeyName String
    The name of the host shared key to be added. The name can be a maximum of 128 characters in length.
    instanceId String
    The ID of the Bastion instance.
    passPhrase String
    The password of the private key. The value is a Base64-encoded string.
    privateKey String
    The private key. The value is a Base64-encoded string.
    privateKeyFingerPrint String
    The fingerprint of the private key.

    Import

    Bastion Host Share Key can be imported using the id, e.g.

    $ pulumi import alicloud:bastionhost/hostShareKey:HostShareKey example <instance_id>:<host_share_key_id>

    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.53.0 published on Wednesday, Apr 17, 2024 by Pulumi
    pulumi/pulumi-alicloud