1. Docs
  2. Reference
  3. API
  4. AWS
  5. iam
  6. AccountAlias

AccountAlias

Note: There is only a single account alias per AWS account.

Manages the account alias for the AWS Account.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @alias = new Aws.Iam.AccountAlias("alias", new Aws.Iam.AccountAliasArgs
        {
            AccountAlias = "my-account-alias",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/iam"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := iam.NewAccountAlias(ctx, "alias", &iam.AccountAliasArgs{
            AccountAlias: pulumi.String("my-account-alias"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aws as aws

alias = aws.iam.AccountAlias("alias", account_alias="my-account-alias")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const alias = new aws.iam.AccountAlias("alias", {
    accountAlias: "my-account-alias",
});

Create a AccountAlias Resource

new AccountAlias(name: string, args: AccountAliasArgs, opts?: CustomResourceOptions);
def AccountAlias(resource_name, opts=None, account_alias=None, __props__=None);
func NewAccountAlias(ctx *Context, name string, args AccountAliasArgs, opts ...ResourceOption) (*AccountAlias, error)
public AccountAlias(string name, AccountAliasArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args AccountAliasArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AccountAliasArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AccountAliasArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

AccountAlias Resource Properties

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

Inputs

The AccountAlias resource accepts the following input properties:

Alias string

The account alias

AccountAlias string

The account alias

accountAlias string

The account alias

account_alias str

The account alias

Outputs

All input properties are implicitly available as output properties. Additionally, the AccountAlias 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing AccountAlias Resource

Get an existing AccountAlias 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?: AccountAliasState, opts?: CustomResourceOptions): AccountAlias
static get(resource_name, id, opts=None, account_alias=None, __props__=None);
func GetAccountAlias(ctx *Context, name string, id IDInput, state *AccountAliasState, opts ...ResourceOption) (*AccountAlias, error)
public static AccountAlias Get(string name, Input<string> id, AccountAliasState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Alias string

The account alias

AccountAlias string

The account alias

accountAlias string

The account alias

account_alias str

The account alias

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.