1. Packages
  2. StrongDM
  3. API Docs
  4. RemoteIdentity
StrongDM v1.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

sdm.RemoteIdentity

Explore with Pulumi AI

sdm logo
StrongDM v1.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg

    RemoteIdentities define the username to be used for a specific account when connecting to a remote resource using that group.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      user:
        type: sdm:RemoteIdentity
        properties:
          id: i-0900909
          username: user
    

    This resource can be imported using the import command.

    Create RemoteIdentity Resource

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

    Constructor syntax

    new RemoteIdentity(name: string, args: RemoteIdentityArgs, opts?: CustomResourceOptions);
    @overload
    def RemoteIdentity(resource_name: str,
                       args: RemoteIdentityArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def RemoteIdentity(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       account_id: Optional[str] = None,
                       remote_identity_group_id: Optional[str] = None,
                       username: Optional[str] = None)
    func NewRemoteIdentity(ctx *Context, name string, args RemoteIdentityArgs, opts ...ResourceOption) (*RemoteIdentity, error)
    public RemoteIdentity(string name, RemoteIdentityArgs args, CustomResourceOptions? opts = null)
    public RemoteIdentity(String name, RemoteIdentityArgs args)
    public RemoteIdentity(String name, RemoteIdentityArgs args, CustomResourceOptions options)
    
    type: sdm:RemoteIdentity
    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 RemoteIdentityArgs
    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 RemoteIdentityArgs
    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 RemoteIdentityArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RemoteIdentityArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RemoteIdentityArgs
    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 remoteIdentityResource = new Sdm.RemoteIdentity("remoteIdentityResource", new()
    {
        AccountId = "string",
        RemoteIdentityGroupId = "string",
        Username = "string",
    });
    
    example, err := sdm.NewRemoteIdentity(ctx, "remoteIdentityResource", &sdm.RemoteIdentityArgs{
    	AccountId:             pulumi.String("string"),
    	RemoteIdentityGroupId: pulumi.String("string"),
    	Username:              pulumi.String("string"),
    })
    
    var remoteIdentityResource = new RemoteIdentity("remoteIdentityResource", RemoteIdentityArgs.builder()
        .accountId("string")
        .remoteIdentityGroupId("string")
        .username("string")
        .build());
    
    remote_identity_resource = sdm.RemoteIdentity("remoteIdentityResource",
        account_id="string",
        remote_identity_group_id="string",
        username="string")
    
    const remoteIdentityResource = new sdm.RemoteIdentity("remoteIdentityResource", {
        accountId: "string",
        remoteIdentityGroupId: "string",
        username: "string",
    });
    
    type: sdm:RemoteIdentity
    properties:
        accountId: string
        remoteIdentityGroupId: string
        username: string
    

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

    AccountId string
    The account for this remote identity.
    RemoteIdentityGroupId string
    The remote identity group.
    Username string
    The username to be used as the remote identity for this account.
    AccountId string
    The account for this remote identity.
    RemoteIdentityGroupId string
    The remote identity group.
    Username string
    The username to be used as the remote identity for this account.
    accountId String
    The account for this remote identity.
    remoteIdentityGroupId String
    The remote identity group.
    username String
    The username to be used as the remote identity for this account.
    accountId string
    The account for this remote identity.
    remoteIdentityGroupId string
    The remote identity group.
    username string
    The username to be used as the remote identity for this account.
    account_id str
    The account for this remote identity.
    remote_identity_group_id str
    The remote identity group.
    username str
    The username to be used as the remote identity for this account.
    accountId String
    The account for this remote identity.
    remoteIdentityGroupId String
    The remote identity group.
    username String
    The username to be used as the remote identity for this account.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RemoteIdentity Resource

    Get an existing RemoteIdentity 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?: RemoteIdentityState, opts?: CustomResourceOptions): RemoteIdentity
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            remote_identity_group_id: Optional[str] = None,
            username: Optional[str] = None) -> RemoteIdentity
    func GetRemoteIdentity(ctx *Context, name string, id IDInput, state *RemoteIdentityState, opts ...ResourceOption) (*RemoteIdentity, error)
    public static RemoteIdentity Get(string name, Input<string> id, RemoteIdentityState? state, CustomResourceOptions? opts = null)
    public static RemoteIdentity get(String name, Output<String> id, RemoteIdentityState 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:
    AccountId string
    The account for this remote identity.
    RemoteIdentityGroupId string
    The remote identity group.
    Username string
    The username to be used as the remote identity for this account.
    AccountId string
    The account for this remote identity.
    RemoteIdentityGroupId string
    The remote identity group.
    Username string
    The username to be used as the remote identity for this account.
    accountId String
    The account for this remote identity.
    remoteIdentityGroupId String
    The remote identity group.
    username String
    The username to be used as the remote identity for this account.
    accountId string
    The account for this remote identity.
    remoteIdentityGroupId string
    The remote identity group.
    username string
    The username to be used as the remote identity for this account.
    account_id str
    The account for this remote identity.
    remote_identity_group_id str
    The remote identity group.
    username str
    The username to be used as the remote identity for this account.
    accountId String
    The account for this remote identity.
    remoteIdentityGroupId String
    The remote identity group.
    username String
    The username to be used as the remote identity for this account.

    Import

    A RemoteIdentity can be imported using the id, e.g.,

    $ pulumi import sdm:index/remoteIdentity:RemoteIdentity example i-12345678
    

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

    Package Details

    Repository
    sdm pierskarsenbarg/pulumi-sdm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sdm Terraform Provider.
    sdm logo
    StrongDM v1.21.0 published on Monday, Nov 4, 2024 by Piers Karsenbarg