Try AWS Native preview for resources not in the classic version.
aws.iam.AccountAlias
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Note: There is only a single account alias per AWS account.
Manages the account alias for the AWS Account.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var @alias = new Aws.Iam.AccountAlias("alias", new()
{
Alias = "my-account-alias",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
"github.com/pulumi/pulumi/sdk/v3/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
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.AccountAlias;
import com.pulumi.aws.iam.AccountAliasArgs;
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) {
var alias = new AccountAlias("alias", AccountAliasArgs.builder()
.accountAlias("my-account-alias")
.build());
}
}
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"});
resources:
alias:
type: aws:iam:AccountAlias
properties:
accountAlias: my-account-alias
Create AccountAlias Resource
new AccountAlias(name: string, args: AccountAliasArgs, opts?: CustomResourceOptions);
@overload
def AccountAlias(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_alias: Optional[str] = None)
@overload
def AccountAlias(resource_name: str,
args: AccountAliasArgs,
opts: Optional[ResourceOptions] = None)
func NewAccountAlias(ctx *Context, name string, args AccountAliasArgs, opts ...ResourceOption) (*AccountAlias, error)
public AccountAlias(string name, AccountAliasArgs args, CustomResourceOptions? opts = null)
public AccountAlias(String name, AccountAliasArgs args)
public AccountAlias(String name, AccountAliasArgs args, CustomResourceOptions options)
type: aws:iam:AccountAlias
properties: # The arguments to resource properties.
options: # 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.
- resource_name str
- The unique name of the resource.
- args AccountAliasArgs
- 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 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.
- name String
- The unique name of the resource.
- args AccountAliasArgs
- The arguments to resource properties.
- options 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 Architecture and Concepts docs.
Inputs
The AccountAlias resource accepts the following input properties:
- Alias string
The account alias
- Account
Alias string The account alias
- account
Alias String The account alias
- account
Alias string The account alias
- account_
alias str The account alias
- account
Alias String 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 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 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
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_alias: Optional[str] = None) -> AccountAlias
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)
public static AccountAlias get(String name, Output<String> id, AccountAliasState 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.
- Alias string
The account alias
- Account
Alias string The account alias
- account
Alias String The account alias
- account
Alias string The account alias
- account_
alias str The account alias
- account
Alias String The account alias
Import
The current Account Alias can be imported using the account_alias
, e.g.,
$ pulumi import aws:iam/accountAlias:AccountAlias alias my-account-alias
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.