1. Packages
  2. StrongDM
  3. API Docs
  4. IdentityAlias
StrongDM v1.26.0 published on Friday, Mar 21, 2025 by Piers Karsenbarg

sdm.IdentityAlias

Explore with Pulumi AI

IdentityAliases define the username to be used for a specific account when connecting to a remote resource using that identity set.

Example Usage

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

This resource can be imported using the import command.

Create IdentityAlias Resource

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

Constructor syntax

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

@overload
def IdentityAlias(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  account_id: Optional[str] = None,
                  identity_set_id: Optional[str] = None,
                  username: Optional[str] = None)
func NewIdentityAlias(ctx *Context, name string, args IdentityAliasArgs, opts ...ResourceOption) (*IdentityAlias, error)
public IdentityAlias(string name, IdentityAliasArgs args, CustomResourceOptions? opts = null)
public IdentityAlias(String name, IdentityAliasArgs args)
public IdentityAlias(String name, IdentityAliasArgs args, CustomResourceOptions options)
type: sdm:IdentityAlias
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. IdentityAliasArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. IdentityAliasArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. IdentityAliasArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. IdentityAliasArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IdentityAliasArgs
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 identityAliasResource = new Sdm.IdentityAlias("identityAliasResource", new()
{
    AccountId = "string",
    IdentitySetId = "string",
    Username = "string",
});
Copy
example, err := sdm.NewIdentityAlias(ctx, "identityAliasResource", &sdm.IdentityAliasArgs{
	AccountId:     pulumi.String("string"),
	IdentitySetId: pulumi.String("string"),
	Username:      pulumi.String("string"),
})
Copy
var identityAliasResource = new IdentityAlias("identityAliasResource", IdentityAliasArgs.builder()
    .accountId("string")
    .identitySetId("string")
    .username("string")
    .build());
Copy
identity_alias_resource = sdm.IdentityAlias("identityAliasResource",
    account_id="string",
    identity_set_id="string",
    username="string")
Copy
const identityAliasResource = new sdm.IdentityAlias("identityAliasResource", {
    accountId: "string",
    identitySetId: "string",
    username: "string",
});
Copy
type: sdm:IdentityAlias
properties:
    accountId: string
    identitySetId: string
    username: string
Copy

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

AccountId This property is required. string
The account for this identity alias.
IdentitySetId This property is required. string
The identity set.
Username This property is required. string
The username to be used as the identity alias for this account.
AccountId This property is required. string
The account for this identity alias.
IdentitySetId This property is required. string
The identity set.
Username This property is required. string
The username to be used as the identity alias for this account.
accountId This property is required. String
The account for this identity alias.
identitySetId This property is required. String
The identity set.
username This property is required. String
The username to be used as the identity alias for this account.
accountId This property is required. string
The account for this identity alias.
identitySetId This property is required. string
The identity set.
username This property is required. string
The username to be used as the identity alias for this account.
account_id This property is required. str
The account for this identity alias.
identity_set_id This property is required. str
The identity set.
username This property is required. str
The username to be used as the identity alias for this account.
accountId This property is required. String
The account for this identity alias.
identitySetId This property is required. String
The identity set.
username This property is required. String
The username to be used as the identity alias for this account.

Outputs

All input properties are implicitly available as output properties. Additionally, the IdentityAlias 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 IdentityAlias Resource

Get an existing IdentityAlias 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?: IdentityAliasState, opts?: CustomResourceOptions): IdentityAlias
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        identity_set_id: Optional[str] = None,
        username: Optional[str] = None) -> IdentityAlias
func GetIdentityAlias(ctx *Context, name string, id IDInput, state *IdentityAliasState, opts ...ResourceOption) (*IdentityAlias, error)
public static IdentityAlias Get(string name, Input<string> id, IdentityAliasState? state, CustomResourceOptions? opts = null)
public static IdentityAlias get(String name, Output<String> id, IdentityAliasState state, CustomResourceOptions options)
resources:  _:    type: sdm:IdentityAlias    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 identity alias.
IdentitySetId string
The identity set.
Username string
The username to be used as the identity alias for this account.
AccountId string
The account for this identity alias.
IdentitySetId string
The identity set.
Username string
The username to be used as the identity alias for this account.
accountId String
The account for this identity alias.
identitySetId String
The identity set.
username String
The username to be used as the identity alias for this account.
accountId string
The account for this identity alias.
identitySetId string
The identity set.
username string
The username to be used as the identity alias for this account.
account_id str
The account for this identity alias.
identity_set_id str
The identity set.
username str
The username to be used as the identity alias for this account.
accountId String
The account for this identity alias.
identitySetId String
The identity set.
username String
The username to be used as the identity alias for this account.

Import

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

$ pulumi import sdm:index/identityAlias:IdentityAlias example i-12345678
Copy

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.