This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

ram¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

class pulumi_alicloud.ram.AccessKey(resource_name, opts=None, pgp_key=None, secret_file=None, status=None, user_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a RAM User access key resource.

NOTE: You should set the secret_file if you want to get the access key.

import pulumi
import pulumi_alicloud as alicloud

# Create a new RAM access key for user.
user = alicloud.ram.User("user",
    comments="yoyoyo",
    display_name="user_display_name",
    email="hello.uuu@aaa.com",
    force=True,
    mobile="86-18688888888")
ak = alicloud.ram.AccessKey("ak",
    secret_file="/xxx/xxx/xxx.txt",
    user_name=user.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
pgp_key (pulumi.Input[str]) – Either a base-64 encoded PGP public key, or a keybase username in the form keybase:some_person_that_exists
secret_file (pulumi.Input[str]) – The name of file that can save access key id and access key secret. Strongly suggest you to specified it when you creating access key, otherwise, you wouldn’t get its secret ever.
status (pulumi.Input[str]) – Status of access key. It must be Active or Inactive. Default value is Active.
user*name (pulumi.Input[str]) –
Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”*”, and must not begin with a hyphen.

key_fingerprint: pulumi.Output[str] = None¶: The fingerprint of the PGP key used to encrypt the secret

pgp_key: pulumi.Output[str] = None¶: Either a base-64 encoded PGP public key, or a keybase username in the form keybase:some_person_that_exists

secret_file: pulumi.Output[str] = None¶: The name of file that can save access key id and access key secret. Strongly suggest you to specified it when you creating access key, otherwise, you wouldn’t get its secret ever.

status: pulumi.Output[str] = None¶: Status of access key. It must be Active or Inactive. Default value is Active.

user_name: pulumi.Output[str] = None¶: Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”_”, and must not begin with a hyphen.

static get(resource_name, id, opts=None, encrypted_secret=None, key_fingerprint=None, pgp_key=None, secret_file=None, status=None, user_name=None)¶

Get an existing AccessKey resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
key_fingerprint (pulumi.Input[str]) – The fingerprint of the PGP key used to encrypt the secret
pgp_key (pulumi.Input[str]) – Either a base-64 encoded PGP public key, or a keybase username in the form keybase:some_person_that_exists
secret_file (pulumi.Input[str]) – The name of file that can save access key id and access key secret. Strongly suggest you to specified it when you creating access key, otherwise, you wouldn’t get its secret ever.
status (pulumi.Input[str]) – Status of access key. It must be Active or Inactive. Default value is Active.
user*name (pulumi.Input[str]) –
Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”*”, and must not begin with a hyphen.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.AccountAlias(resource_name, opts=None, account_alias=None, __props__=None, __name__=None, __opts__=None)¶

Provides a RAM cloud account alias.

import pulumi
import pulumi_alicloud as alicloud

# Create a alias for cloud account.
alias = alicloud.ram.AccountAlias("alias", account_alias="hallo")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
account_alias (pulumi.Input[str]) – Alias of cloud account. This name can have a string of 3 to 32 characters, must contain only alphanumeric characters or hyphens, such as “-“, and must not begin with a hyphen.

account_alias: pulumi.Output[str] = None¶: Alias of cloud account. This name can have a string of 3 to 32 characters, must contain only alphanumeric characters or hyphens, such as “-“, and must not begin with a hyphen.

static get(resource_name, id, opts=None, account_alias=None)¶

Get an existing AccountAlias resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
account_alias (pulumi.Input[str]) – Alias of cloud account. This name can have a string of 3 to 32 characters, must contain only alphanumeric characters or hyphens, such as “-“, and must not begin with a hyphen.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.AccountPasswordPolicy(resource_name, opts=None, hard_expiry=None, max_login_attempts=None, max_password_age=None, minimum_password_length=None, password_reuse_prevention=None, require_lowercase_characters=None, require_numbers=None, require_symbols=None, require_uppercase_characters=None, __props__=None, __name__=None, __opts__=None)¶

Create a AccountPasswordPolicy resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[bool] hard_expiry: Specifies if a password can expire in a hard way. Default to false. :param pulumi.Input[float] max_login_attempts: Maximum logon attempts with an incorrect password within an hour. Valid value range: [0-32]. Default to 5. :param pulumi.Input[float] max_password_age: The number of days after which password expires. A value of 0 indicates that the password never expires. Valid value range: [0-1095]. Default to 0. :param pulumi.Input[float] minimum_password_length: Minimal required length of password for a user. Valid value range: [8-32]. Default to 12. :param pulumi.Input[float] password_reuse_prevention: User is not allowed to use the latest number of passwords specified in this parameter. A value of 0 indicates the password history check policy is disabled. Valid value range: [0-24]. Default to 0. :param pulumi.Input[bool] require_lowercase_characters: Specifies if the occurrence of a lowercase character in the password is mandatory. Default to true. :param pulumi.Input[bool] require_numbers: Specifies if the occurrence of a number in the password is mandatory. Default to true. :param pulumi.Input[bool] require_symbols: (Optional Specifies if the occurrence of a special character in the password is mandatory. Default to true. :param pulumi.Input[bool] require_uppercase_characters: Specifies if the occurrence of an uppercase character in the password is mandatory. Default to true.

hard_expiry: pulumi.Output[bool] = None¶: Specifies if a password can expire in a hard way. Default to false.

max_login_attempts: pulumi.Output[float] = None¶: Maximum logon attempts with an incorrect password within an hour. Valid value range: [0-32]. Default to 5.

max_password_age: pulumi.Output[float] = None¶: The number of days after which password expires. A value of 0 indicates that the password never expires. Valid value range: [0-1095]. Default to 0.

minimum_password_length: pulumi.Output[float] = None¶: Minimal required length of password for a user. Valid value range: [8-32]. Default to 12.

password_reuse_prevention: pulumi.Output[float] = None¶: User is not allowed to use the latest number of passwords specified in this parameter. A value of 0 indicates the password history check policy is disabled. Valid value range: [0-24]. Default to 0.

require_lowercase_characters: pulumi.Output[bool] = None¶: Specifies if the occurrence of a lowercase character in the password is mandatory. Default to true.

require_numbers: pulumi.Output[bool] = None¶: Specifies if the occurrence of a number in the password is mandatory. Default to true.

require_symbols: pulumi.Output[bool] = None¶: (Optional Specifies if the occurrence of a special character in the password is mandatory. Default to true.

require_uppercase_characters: pulumi.Output[bool] = None¶: Specifies if the occurrence of an uppercase character in the password is mandatory. Default to true.

static get(resource_name, id, opts=None, hard_expiry=None, max_login_attempts=None, max_password_age=None, minimum_password_length=None, password_reuse_prevention=None, require_lowercase_characters=None, require_numbers=None, require_symbols=None, require_uppercase_characters=None)¶

Get an existing AccountPasswordPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
hard_expiry (pulumi.Input[bool]) – Specifies if a password can expire in a hard way. Default to false.
max_login_attempts (pulumi.Input[float]) – Maximum logon attempts with an incorrect password within an hour. Valid value range: [0-32]. Default to 5.
max_password_age (pulumi.Input[float]) – The number of days after which password expires. A value of 0 indicates that the password never expires. Valid value range: [0-1095]. Default to 0.
minimum_password_length (pulumi.Input[float]) – Minimal required length of password for a user. Valid value range: [8-32]. Default to 12.
password_reuse_prevention (pulumi.Input[float]) – User is not allowed to use the latest number of passwords specified in this parameter. A value of 0 indicates the password history check policy is disabled. Valid value range: [0-24]. Default to 0.
require_lowercase_characters (pulumi.Input[bool]) – Specifies if the occurrence of a lowercase character in the password is mandatory. Default to true.
require_numbers (pulumi.Input[bool]) – Specifies if the occurrence of a number in the password is mandatory. Default to true.
require_symbols (pulumi.Input[bool]) – (Optional Specifies if the occurrence of a special character in the password is mandatory. Default to true.
require_uppercase_characters (pulumi.Input[bool]) – Specifies if the occurrence of an uppercase character in the password is mandatory. Default to true.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.Alias(resource_name, opts=None, account_alias=None, __props__=None, __name__=None, __opts__=None)¶

Create a Alias resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource.

static get(resource_name, id, opts=None, account_alias=None)¶

Get an existing Alias resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.AwaitableGetAccountAliasResult(account_alias=None, id=None, output_file=None)¶

class pulumi_alicloud.ram.AwaitableGetAccountAliasesResult(account_alias=None, id=None, output_file=None)¶

class pulumi_alicloud.ram.AwaitableGetGroupsResult(groups=None, id=None, name_regex=None, names=None, output_file=None, policy_name=None, policy_type=None, user_name=None)¶

class pulumi_alicloud.ram.AwaitableGetPoliciesResult(group_name=None, id=None, name_regex=None, names=None, output_file=None, policies=None, role_name=None, type=None, user_name=None)¶

class pulumi_alicloud.ram.AwaitableGetRolesResult(id=None, ids=None, name_regex=None, names=None, output_file=None, policy_name=None, policy_type=None, roles=None)¶

class pulumi_alicloud.ram.AwaitableGetUsersResult(group_name=None, id=None, ids=None, name_regex=None, names=None, output_file=None, policy_name=None, policy_type=None, users=None)¶

class pulumi_alicloud.ram.GetAccountAliasResult(account_alias=None, id=None, output_file=None)¶

A collection of values returned by getAccountAlias.

id = None¶: The provider-assigned unique ID for this managed resource.

class pulumi_alicloud.ram.GetAccountAliasesResult(account_alias=None, id=None, output_file=None)¶

A collection of values returned by getAccountAliases.

account_alias = None¶: Alias of the account.

id = None¶: The provider-assigned unique ID for this managed resource.

class pulumi_alicloud.ram.GetGroupsResult(groups=None, id=None, name_regex=None, names=None, output_file=None, policy_name=None, policy_type=None, user_name=None)¶

A collection of values returned by getGroups.

groups = None¶: A list of groups. Each element contains the following attributes:

id = None¶: The provider-assigned unique ID for this managed resource.

names = None¶: A list of ram group names.

class pulumi_alicloud.ram.GetPoliciesResult(group_name=None, id=None, name_regex=None, names=None, output_file=None, policies=None, role_name=None, type=None, user_name=None)¶

A collection of values returned by getPolicies.

id = None¶: The provider-assigned unique ID for this managed resource.

names = None¶: A list of ram group names.

policies = None¶: A list of policies. Each element contains the following attributes:

type = None¶: Type of the policy.

class pulumi_alicloud.ram.GetRolesResult(id=None, ids=None, name_regex=None, names=None, output_file=None, policy_name=None, policy_type=None, roles=None)¶

A collection of values returned by getRoles.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of ram role IDs.

names = None¶: A list of ram role names.

roles = None¶: A list of roles. Each element contains the following attributes:

class pulumi_alicloud.ram.GetUsersResult(group_name=None, id=None, ids=None, name_regex=None, names=None, output_file=None, policy_name=None, policy_type=None, users=None)¶

A collection of values returned by getUsers.

id = None¶: The provider-assigned unique ID for this managed resource.

ids = None¶: A list of ram user IDs.

names = None¶: A list of ram user names.

users = None¶: A list of users. Each element contains the following attributes:

class pulumi_alicloud.ram.Group(resource_name, opts=None, comments=None, force=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Create a Group resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] comments: Comment of the RAM group. This parameter can have a string of 1 to 128 characters. :param pulumi.Input[bool] force: This parameter is used for resource destroy. Default value is false. :param pulumi.Input[str] name: Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.

comments: pulumi.Output[str] = None¶: Comment of the RAM group. This parameter can have a string of 1 to 128 characters.

force: pulumi.Output[bool] = None¶: This parameter is used for resource destroy. Default value is false.

name: pulumi.Output[str] = None¶: Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.

static get(resource_name, id, opts=None, comments=None, force=None, name=None)¶

Get an existing Group resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
comments (pulumi.Input[str]) – Comment of the RAM group. This parameter can have a string of 1 to 128 characters.
force (pulumi.Input[bool]) – This parameter is used for resource destroy. Default value is false.
name (pulumi.Input[str]) – Name of the RAM group. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.GroupMembership(resource_name, opts=None, group_name=None, user_names=None, __props__=None, __name__=None, __opts__=None)¶

Provides a RAM Group membership resource.

import pulumi
import pulumi_alicloud as alicloud

# Create a RAM Group membership.
group = alicloud.ram.Group("group",
    comments="this is a group comments.",
    force=True)
user = alicloud.ram.User("user",
    comments="yoyoyo",
    display_name="user_display_name",
    email="hello.uuu@aaa.com",
    force=True,
    mobile="86-18688888888")
user1 = alicloud.ram.User("user1",
    comments="yoyoyo",
    display_name="user_display_name1",
    email="hello.uuu@aaa.com",
    force=True,
    mobile="86-18688888889")
membership = alicloud.ram.GroupMembership("membership",
    group_name=group.name,
    user_names=[
        user.name,
        user1.name,
    ])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
group_name (pulumi.Input[str]) – Name of the RAM group. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
user*names (pulumi.Input[list]) –
Set of user name which will be added to group. Each name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”*”, and must not begin with a hyphen.

group_name: pulumi.Output[str] = None¶: Name of the RAM group. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.

user_names: pulumi.Output[list] = None¶: Set of user name which will be added to group. Each name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”_”, and must not begin with a hyphen.

static get(resource_name, id, opts=None, group_name=None, user_names=None)¶

Get an existing GroupMembership resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
group_name (pulumi.Input[str]) – Name of the RAM group. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
user*names (pulumi.Input[list]) –
Set of user name which will be added to group. Each name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”*”, and must not begin with a hyphen.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.GroupPolicyAttachment(resource_name, opts=None, group_name=None, policy_name=None, policy_type=None, __props__=None, __name__=None, __opts__=None)¶

Provides a RAM Group Policy attachment resource.

import pulumi
import pulumi_alicloud as alicloud

# Create a RAM Group Policy attachment.
group = alicloud.ram.Group("group",
    comments="this is a group comments.",
    force=True)
policy = alicloud.ram.Policy("policy",
    description="this is a policy test",
    document="""    {
      "Statement": [
        {
          "Action": [
            "oss:ListObjects",
            "oss:GetObject"
          ],
          "Effect": "Allow",
          "Resource": [
            "acs:oss:*:*:mybucket",
            "acs:oss:*:*:mybucket/*"
          ]
        }
      ],
        "Version": "1"
    }

""",
    force=True)
attach = alicloud.ram.GroupPolicyAttachment("attach",
    group_name=group.name,
    policy_name=policy.name,
    policy_type=policy.type)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
group_name (pulumi.Input[str]) – Name of the RAM group. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
policy_name (pulumi.Input[str]) – Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
policy_type (pulumi.Input[str]) – Type of the RAM policy. It must be Custom or System.

group_name: pulumi.Output[str] = None¶: Name of the RAM group. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.

policy_name: pulumi.Output[str] = None¶: Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.

policy_type: pulumi.Output[str] = None¶: Type of the RAM policy. It must be Custom or System.

static get(resource_name, id, opts=None, group_name=None, policy_name=None, policy_type=None)¶

Get an existing GroupPolicyAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
group_name (pulumi.Input[str]) – Name of the RAM group. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
policy_name (pulumi.Input[str]) – Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
policy_type (pulumi.Input[str]) – Type of the RAM policy. It must be Custom or System.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.LoginProfile(resource_name, opts=None, mfa_bind_required=None, password=None, password_reset_required=None, user_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a RAM User Login Profile resource.

import pulumi
import pulumi_alicloud as alicloud

# Create a RAM login profile.
user = alicloud.ram.User("user",
    comments="yoyoyo",
    display_name="user_display_name",
    email="hello.uuu@aaa.com",
    force=True,
    mobile="86-18688888888")
profile = alicloud.ram.LoginProfile("profile",
    password="Yourpassword1234",
    user_name=user.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
mfa_bind_required (pulumi.Input[bool]) – This parameter indicates whether the MFA needs to be bind when the user first logs in. Default value is false.
password (pulumi.Input[str]) – Password of the RAM user.
password_reset_required (pulumi.Input[bool]) – This parameter indicates whether the password needs to be reset when the user first logs in. Default value is false.
user*name (pulumi.Input[str]) –
Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”*”, and must not begin with a hyphen.

mfa_bind_required: pulumi.Output[bool] = None¶: This parameter indicates whether the MFA needs to be bind when the user first logs in. Default value is false.

password: pulumi.Output[str] = None¶: Password of the RAM user.

password_reset_required: pulumi.Output[bool] = None¶: This parameter indicates whether the password needs to be reset when the user first logs in. Default value is false.

user_name: pulumi.Output[str] = None¶: Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”_”, and must not begin with a hyphen.

static get(resource_name, id, opts=None, mfa_bind_required=None, password=None, password_reset_required=None, user_name=None)¶

Get an existing LoginProfile resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
mfa_bind_required (pulumi.Input[bool]) – This parameter indicates whether the MFA needs to be bind when the user first logs in. Default value is false.
password (pulumi.Input[str]) – Password of the RAM user.
password_reset_required (pulumi.Input[bool]) – This parameter indicates whether the password needs to be reset when the user first logs in. Default value is false.
user*name (pulumi.Input[str]) –
Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”*”, and must not begin with a hyphen.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.Policy(resource_name, opts=None, description=None, document=None, force=None, name=None, statements=None, version=None, __props__=None, __name__=None, __opts__=None)¶

Create a Policy resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: Description of the RAM policy. This name can have a string of 1 to 1024 characters. :param pulumi.Input[str] document: Document of the RAM policy. It is required when the statement is not specified. :param pulumi.Input[bool] force: This parameter is used for resource destroy. Default value is false. :param pulumi.Input[str] name: Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen. :param pulumi.Input[list] statements: (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) Statements of the RAM policy document. It is required when the document is not specified. :param pulumi.Input[str] version: (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) Version of the RAM policy document. Valid value is 1. Default value is 1.

The statements object supports the following:

actions (pulumi.Input[list]) - (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of operations for the resource. The format of each item in this list is ${service}:${action_name}, such as oss:ListBuckets and ecs:Describe*. The ${service} can be ecs, oss, ots and so on, the ${action_name} refers to the name of an api interface which related to the ${service}.
effect (pulumi.Input[str]) - (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) This parameter indicates whether or not the action is allowed. Valid values are Allow and Deny.
resources (pulumi.Input[list]) - (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of specific objects which will be authorized. The format of each item in this list is acs:${service}:${region}:${account_id}:${relative_id}, such as acs:ecs:*:*:instance/inst-002 and acs:oss:*:1234567890000:mybucket. The ${service} can be ecs, oss, ots and so on, the ${region} is the region info which can use * replace when it is not supplied, the ${account_id} refers to someone’s Alicloud account id or you can use * to replace, the ${relative_id} is the resource description section which related to the ${service}.

attachment_count: pulumi.Output[float] = None¶: The policy attachment count.

description: pulumi.Output[str] = None¶: Description of the RAM policy. This name can have a string of 1 to 1024 characters.

document: pulumi.Output[str] = None¶: Document of the RAM policy. It is required when the statement is not specified.

force: pulumi.Output[bool] = None¶: This parameter is used for resource destroy. Default value is false.

name: pulumi.Output[str] = None¶: Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.

statements: pulumi.Output[list] = None¶

(It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) Statements of the RAM policy document. It is required when the document is not specified.

actions (list) - (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of operations for the resource. The format of each item in this list is ${service}:${action_name}, such as oss:ListBuckets and ecs:Describe*. The ${service} can be ecs, oss, ots and so on, the ${action_name} refers to the name of an api interface which related to the ${service}.
effect (str) - (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) This parameter indicates whether or not the action is allowed. Valid values are Allow and Deny.
resources (list) - (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of specific objects which will be authorized. The format of each item in this list is acs:${service}:${region}:${account_id}:${relative_id}, such as acs:ecs:*:*:instance/inst-002 and acs:oss:*:1234567890000:mybucket. The ${service} can be ecs, oss, ots and so on, the ${region} is the region info which can use * replace when it is not supplied, the ${account_id} refers to someone’s Alicloud account id or you can use * to replace, the ${relative_id} is the resource description section which related to the ${service}.

type: pulumi.Output[str] = None¶: The policy type.

version: pulumi.Output[str] = None¶: (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) Version of the RAM policy document. Valid value is 1. Default value is 1.

static get(resource_name, id, opts=None, attachment_count=None, description=None, document=None, force=None, name=None, statements=None, type=None, version=None)¶

Get an existing Policy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
attachment_count (pulumi.Input[float]) – The policy attachment count.
description (pulumi.Input[str]) – Description of the RAM policy. This name can have a string of 1 to 1024 characters.
document (pulumi.Input[str]) – Document of the RAM policy. It is required when the statement is not specified.
force (pulumi.Input[bool]) – This parameter is used for resource destroy. Default value is false.
name (pulumi.Input[str]) – Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
statements (pulumi.Input[list]) – (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) Statements of the RAM policy document. It is required when the document is not specified.
type (pulumi.Input[str]) – The policy type.
version (pulumi.Input[str]) – (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) Version of the RAM policy document. Valid value is 1. Default value is 1.

The statements object supports the following:

actions (pulumi.Input[list]) - (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of operations for the resource. The format of each item in this list is ${service}:${action_name}, such as oss:ListBuckets and ecs:Describe*. The ${service} can be ecs, oss, ots and so on, the ${action_name} refers to the name of an api interface which related to the ${service}.
effect (pulumi.Input[str]) - (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) This parameter indicates whether or not the action is allowed. Valid values are Allow and Deny.
resources (pulumi.Input[list]) - (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of specific objects which will be authorized. The format of each item in this list is acs:${service}:${region}:${account_id}:${relative_id}, such as acs:ecs:*:*:instance/inst-002 and acs:oss:*:1234567890000:mybucket. The ${service} can be ecs, oss, ots and so on, the ${region} is the region info which can use * replace when it is not supplied, the ${account_id} refers to someone’s Alicloud account id or you can use * to replace, the ${relative_id} is the resource description section which related to the ${service}.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.Role(resource_name, opts=None, description=None, document=None, force=None, name=None, ram_users=None, services=None, version=None, __props__=None, __name__=None, __opts__=None)¶

Create a Role resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] description: Description of the RAM role. This name can have a string of 1 to 1024 characters. :param pulumi.Input[str] document: Authorization strategy of the RAM role. It is required when the services and ram_users are not specified. :param pulumi.Input[bool] force: This parameter is used for resource destroy. Default value is false. :param pulumi.Input[str] name: Name of the RAM role. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“, “_”, and must not begin with a hyphen. :param pulumi.Input[list] ram_users: (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of ram users who can assume the RAM role. The format of each item in this list is acs:ram::${account_id}:root or acs:ram::${account_id}:user/${user_name}, such as acs:ram::1234567890000:root and acs:ram::1234567890001:user/Mary. The ${user_name} is the name of a RAM user which must exists in the Alicloud account indicated by the ${account_id}. :param pulumi.Input[list] services: (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of services which can assume the RAM role. The format of each item in this list is ${service}.aliyuncs.com or ${account_id}@${service}.aliyuncs.com, such as ecs.aliyuncs.com and 1234567890000@ots.aliyuncs.com. The ${service} can be ecs, log, apigateway and so on, the ${account_id} refers to someone’s Alicloud account id. :param pulumi.Input[str] version: (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) Version of the RAM role policy document. Valid value is 1. Default value is 1.

arn: pulumi.Output[str] = None¶: The role arn.

description: pulumi.Output[str] = None¶: Description of the RAM role. This name can have a string of 1 to 1024 characters.

document: pulumi.Output[str] = None¶: Authorization strategy of the RAM role. It is required when the services and ram_users are not specified.

force: pulumi.Output[bool] = None¶: This parameter is used for resource destroy. Default value is false.

name: pulumi.Output[str] = None¶: Name of the RAM role. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“, “_”, and must not begin with a hyphen.

ram_users: pulumi.Output[list] = None¶: (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of ram users who can assume the RAM role. The format of each item in this list is acs:ram::${account_id}:root or acs:ram::${account_id}:user/${user_name}, such as acs:ram::1234567890000:root and acs:ram::1234567890001:user/Mary. The ${user_name} is the name of a RAM user which must exists in the Alicloud account indicated by the ${account_id}.

role_id: pulumi.Output[str] = None¶: The role ID.

services: pulumi.Output[list] = None¶: (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of services which can assume the RAM role. The format of each item in this list is ${service}.aliyuncs.com or ${account_id}@${service}.aliyuncs.com, such as ecs.aliyuncs.com and 1234567890000@ots.aliyuncs.com. The ${service} can be ecs, log, apigateway and so on, the ${account_id} refers to someone’s Alicloud account id.

version: pulumi.Output[str] = None¶: (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) Version of the RAM role policy document. Valid value is 1. Default value is 1.

static get(resource_name, id, opts=None, arn=None, description=None, document=None, force=None, name=None, ram_users=None, role_id=None, services=None, version=None)¶

Get an existing Role resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The role arn.
description (pulumi.Input[str]) – Description of the RAM role. This name can have a string of 1 to 1024 characters.
document (pulumi.Input[str]) – Authorization strategy of the RAM role. It is required when the services and ram_users are not specified.
force (pulumi.Input[bool]) – This parameter is used for resource destroy. Default value is false.
name (pulumi.Input[str]) – Name of the RAM role. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“, “_”, and must not begin with a hyphen.
ram_users (pulumi.Input[list]) – (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of ram users who can assume the RAM role. The format of each item in this list is acs:ram::${account_id}:root or acs:ram::${account_id}:user/${user_name}, such as acs:ram::1234567890000:root and acs:ram::1234567890001:user/Mary. The ${user_name} is the name of a RAM user which must exists in the Alicloud account indicated by the ${account_id}.
role_id (pulumi.Input[str]) – The role ID.
services (pulumi.Input[list]) – (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) List of services which can assume the RAM role. The format of each item in this list is ${service}.aliyuncs.com or ${account_id}@${service}.aliyuncs.com, such as ecs.aliyuncs.com and 1234567890000@ots.aliyuncs.com. The ${service} can be ecs, log, apigateway and so on, the ${account_id} refers to someone’s Alicloud account id.
version (pulumi.Input[str]) – (It has been deprecated from version 1.49.0, and use field ‘document’ to replace.) Version of the RAM role policy document. Valid value is 1. Default value is 1.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.RoleAttachment(resource_name, opts=None, instance_ids=None, role_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a RAM role attachment resource to bind role for several ECS instances.

import pulumi
import pulumi_alicloud as alicloud

default_zones = alicloud.get_zones(available_disk_category="cloud_efficiency",
    available_resource_creation="VSwitch")
default_instance_types = alicloud.ecs.get_instance_types(availability_zone=default_zones.zones[0]["id"],
    cpu_core_count=2,
    memory_size=4)
default_images = alicloud.ecs.get_images(most_recent=True,
    name_regex="^ubuntu_18.*64",
    owners="system")
default_network = alicloud.vpc.Network("defaultNetwork", cidr_block="172.16.0.0/16")
default_switch = alicloud.vpc.Switch("defaultSwitch",
    availability_zone=default_zones.zones[0]["id"],
    cidr_block="172.16.0.0/24",
    vpc_id=default_network.id)
default_security_group = alicloud.ecs.SecurityGroup("defaultSecurityGroup", vpc_id=default_network.id)
default_security_group_rule = alicloud.ecs.SecurityGroupRule("defaultSecurityGroupRule",
    cidr_ip="172.16.0.0/24",
    ip_protocol="tcp",
    nic_type="intranet",
    policy="accept",
    port_range="22/22",
    priority=1,
    security_group_id=default_security_group.id,
    type="ingress")
config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "ecsInstanceVPCExample"
foo = alicloud.ecs.Instance("foo",
    image_id=default_images.images[0]["id"],
    instance_name=name,
    instance_type=default_instance_types.instance_types[0]["id"],
    internet_charge_type="PayByTraffic",
    internet_max_bandwidth_out=5,
    security_groups=[default_security_group.id],
    system_disk_category="cloud_efficiency",
    vswitch_id=default_switch.id)
role = alicloud.ram.Role("role",
    description="this is a test",
    document="""  {
    "Statement": [
      {
        "Action": "sts:AssumeRole",
        "Effect": "Allow",
        "Principal": {
          "Service": [
            "ecs.aliyuncs.com"
          ]
        }
      }
    ],
    "Version": "1"
  }

""",
    force=True)
attach = alicloud.ram.RoleAttachment("attach",
    instance_ids=[[__item.id for __item in [foo]]],
    role_name=role.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_ids (pulumi.Input[list]) – The list of ECS instance’s IDs.
role*name (pulumi.Input[str]) –
The name of role used to bind. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“, “*”, and must not begin with a hyphen.

instance_ids: pulumi.Output[list] = None¶: The list of ECS instance’s IDs.

role_name: pulumi.Output[str] = None¶: The name of role used to bind. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“, “_”, and must not begin with a hyphen.

static get(resource_name, id, opts=None, instance_ids=None, role_name=None)¶

Get an existing RoleAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
instance_ids (pulumi.Input[list]) – The list of ECS instance’s IDs.
role*name (pulumi.Input[str]) –
The name of role used to bind. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“, “*”, and must not begin with a hyphen.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.RolePolicyAttachment(resource_name, opts=None, policy_name=None, policy_type=None, role_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a RAM Role attachment resource.

import pulumi
import pulumi_alicloud as alicloud

# Create a RAM Role Policy attachment.
role = alicloud.ram.Role("role",
    description="this is a role test.",
    document="""    {
      "Statement": [
        {
          "Action": "sts:AssumeRole",
          "Effect": "Allow",
          "Principal": {
            "Service": [
              "apigateway.aliyuncs.com", 
              "ecs.aliyuncs.com"
            ]
          }
        }
      ],
      "Version": "1"
    }

""",
    force=True)
policy = alicloud.ram.Policy("policy",
    description="this is a policy test",
    document="""  {
    "Statement": [
      {
        "Action": [
          "oss:ListObjects",
          "oss:GetObject"
        ],
        "Effect": "Allow",
        "Resource": [
          "acs:oss:*:*:mybucket",
          "acs:oss:*:*:mybucket/*"
        ]
      }
    ],
      "Version": "1"
  }

""",
    force=True)
attach = alicloud.ram.RolePolicyAttachment("attach",
    policy_name=policy.name,
    policy_type=policy.type,
    role_name=role.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
policy_name (pulumi.Input[str]) – Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
policy_type (pulumi.Input[str]) – Type of the RAM policy. It must be Custom or System.
role*name (pulumi.Input[str]) –
Name of the RAM Role. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“, “*”, and must not begin with a hyphen.

policy_name: pulumi.Output[str] = None¶: Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.

policy_type: pulumi.Output[str] = None¶: Type of the RAM policy. It must be Custom or System.

role_name: pulumi.Output[str] = None¶: Name of the RAM Role. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“, “_”, and must not begin with a hyphen.

static get(resource_name, id, opts=None, policy_name=None, policy_type=None, role_name=None)¶

Get an existing RolePolicyAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
policy_name (pulumi.Input[str]) – Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
policy_type (pulumi.Input[str]) – Type of the RAM policy. It must be Custom or System.
role*name (pulumi.Input[str]) –
Name of the RAM Role. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“, “*”, and must not begin with a hyphen.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.User(resource_name, opts=None, comments=None, display_name=None, email=None, force=None, mobile=None, name=None, __props__=None, __name__=None, __opts__=None)¶

Create a User resource with the given unique name, props, and options. :param str resource_name: The name of the resource. :param pulumi.ResourceOptions opts: Options for the resource. :param pulumi.Input[str] comments: Comment of the RAM user. This parameter can have a string of 1 to 128 characters. :param pulumi.Input[str] displayname: Name of the RAM user which for display. This name can have a string of 1 to 128 characters or Chinese characters, must contain only alphanumeric characters or Chinese characters or hyphens, such as “-“,”.”, and must not end with a hyphen. :param pulumi.Input[str] email: Email of the RAM user. :param pulumi.Input[bool] force: This parameter is used for resource destroy. Default value is ``false``. :param pulumi.Input[str] mobile: Phone number of the RAM user. This number must contain an international area code prefix, just look like this: 86-18600008888. :param pulumi.Input[str] name: Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,””, and must not begin with a hyphen.

comments: pulumi.Output[str] = None¶: Comment of the RAM user. This parameter can have a string of 1 to 128 characters.

display_name: pulumi.Output[str] = None¶: Name of the RAM user which for display. This name can have a string of 1 to 128 characters or Chinese characters, must contain only alphanumeric characters or Chinese characters or hyphens, such as “-“,”.”, and must not end with a hyphen.

email: pulumi.Output[str] = None¶: Email of the RAM user.

force: pulumi.Output[bool] = None¶: This parameter is used for resource destroy. Default value is false.

mobile: pulumi.Output[str] = None¶: Phone number of the RAM user. This number must contain an international area code prefix, just look like this: 86-18600008888.

name: pulumi.Output[str] = None¶: Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”_”, and must not begin with a hyphen.

static get(resource_name, id, opts=None, comments=None, display_name=None, email=None, force=None, mobile=None, name=None)¶

Get an existing User resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
comments (pulumi.Input[str]) – Comment of the RAM user. This parameter can have a string of 1 to 128 characters.
display*name (pulumi.Input[str]) –
Name of the RAM user which for display. This name can have a string of 1 to 128 characters or Chinese characters, must contain only alphanumeric characters or Chinese characters or hyphens, such as “-“,”.”, and must not end with a hyphen.
email (pulumi.Input[str]) – Email of the RAM user.
force (pulumi.Input[bool]) – This parameter is used for resource destroy. Default value is false.
mobile (pulumi.Input[str]) – Phone number of the RAM user. This number must contain an international area code prefix, just look like this: 86-18600008888.
name (pulumi.Input[str]) – Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”*”, and must not begin with a hyphen.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_alicloud.ram.UserPolicyAttachment(resource_name, opts=None, policy_name=None, policy_type=None, user_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a RAM User Policy attachment resource.

import pulumi
import pulumi_alicloud as alicloud

# Create a RAM User Policy attachment.
user = alicloud.ram.User("user",
    comments="yoyoyo",
    display_name="user_display_name",
    email="hello.uuu@aaa.com",
    force=True,
    mobile="86-18688888888")
policy = alicloud.ram.Policy("policy",
    description="this is a policy test",
    document="""  {
    "Statement": [
      {
        "Action": [
          "oss:ListObjects",
          "oss:GetObject"
        ],
        "Effect": "Allow",
        "Resource": [
          "acs:oss:*:*:mybucket",
          "acs:oss:*:*:mybucket/*"
        ]
      }
    ],
      "Version": "1"
  }

""",
    force=True)
attach = alicloud.ram.UserPolicyAttachment("attach",
    policy_name=policy.name,
    policy_type=policy.type,
    user_name=user.name)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
policy_name (pulumi.Input[str]) – Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
policy_type (pulumi.Input[str]) – Type of the RAM policy. It must be Custom or System.
user*name (pulumi.Input[str]) –
Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”*”, and must not begin with a hyphen.

policy_name: pulumi.Output[str] = None¶: Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.

policy_type: pulumi.Output[str] = None¶: Type of the RAM policy. It must be Custom or System.

user_name: pulumi.Output[str] = None¶: Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”_”, and must not begin with a hyphen.

static get(resource_name, id, opts=None, policy_name=None, policy_type=None, user_name=None)¶

Get an existing UserPolicyAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
policy_name (pulumi.Input[str]) – Name of the RAM policy. This name can have a string of 1 to 128 characters, must contain only alphanumeric characters or hyphen “-“, and must not begin with a hyphen.
policy_type (pulumi.Input[str]) – Type of the RAM policy. It must be Custom or System.
user*name (pulumi.Input[str]) –
Name of the RAM user. This name can have a string of 1 to 64 characters, must contain only alphanumeric characters or hyphens, such as “-“,”.”,”*”, and must not begin with a hyphen.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

pulumi_alicloud.ram.get_account_alias(output_file=None, opts=None)¶: Use this data source to access information about an existing resource.

pulumi_alicloud.ram.get_account_aliases(output_file=None, opts=None)¶

This data source provides an alias for the Alibaba Cloud account.

import pulumi
import pulumi_alicloud as alicloud

alias_ds = alicloud.ram.get_account_aliases(output_file="alias.txt")
pulumi.export("accountAlias", alias_ds.account_alias)

pulumi_alicloud.ram.get_groups(name_regex=None, output_file=None, policy_name=None, policy_type=None, user_name=None, opts=None)¶

This data source provides a list of RAM Groups in an Alibaba Cloud account according to the specified filters.

import pulumi
import pulumi_alicloud as alicloud

groups_ds = alicloud.ram.get_groups(name_regex="^group[0-9]*",
    output_file="groups.txt",
    user_name="user1")
pulumi.export("firstGroupName", groups_ds.groups[0]["name"])

Parameters

name_regex (str) – A regex string to filter the returned groups by their names.
policy_name (str) – Filter the results by a specific policy name. If you set this parameter without setting policy_type, it will be automatically set to System.
policy_type (str) – Filter the results by a specific policy type. Valid items are Custom and System. If you set this parameter, you must set policy_name as well.
user_name (str) – Filter the results by a specific the user name.

pulumi_alicloud.ram.get_policies(group_name=None, name_regex=None, output_file=None, role_name=None, type=None, user_name=None, opts=None)¶

This data source provides a list of RAM policies in an Alibaba Cloud account according to the specified filters.

import pulumi
import pulumi_alicloud as alicloud

policies_ds = alicloud.ram.get_policies(group_name="group1",
    output_file="policies.txt",
    type="System",
    user_name="user1")
pulumi.export("firstPolicyName", policies_ds.policies[0]["name"])

Parameters

group_name (str) – Filter results by a specific group name. Returned policies are attached to the specified group.
name_regex (str) – A regex string to filter resulting policies by name.
role_name (str) – Filter results by a specific role name. Returned policies are attached to the specified role.
type (str) – Filter results by a specific policy type. Valid values are Custom and System.
user_name (str) – Filter results by a specific user name. Returned policies are attached to the specified user.

pulumi_alicloud.ram.get_roles(ids=None, name_regex=None, output_file=None, policy_name=None, policy_type=None, opts=None)¶

This data source provides a list of RAM Roles in an Alibaba Cloud account according to the specified filters.

import pulumi
import pulumi_alicloud as alicloud

roles_ds = alicloud.ram.get_roles(name_regex=".*test.*",
    output_file="roles.txt",
    policy_name="AliyunACSDefaultAccess",
    policy_type="Custom")
pulumi.export("firstRoleId", roles_ds.roles[0]["id"])

Parameters

ids (list) –
- A list of ram role IDs.
name_regex (str) – A regex string to filter results by the role name.
policy_name (str) – Filter results by a specific policy name. If you set this parameter without setting policy_type, the later will be automatically set to System. The resulting roles will be attached to the specified policy.
policy_type (str) – Filter results by a specific policy type. Valid values are Custom and System. If you set this parameter, you must set policy_name as well.

pulumi_alicloud.ram.get_users(group_name=None, ids=None, name_regex=None, output_file=None, policy_name=None, policy_type=None, opts=None)¶

This data source provides a list of RAM users in an Alibaba Cloud account according to the specified filters.

import pulumi
import pulumi_alicloud as alicloud

users_ds = alicloud.ram.get_users(group_name="group1",
    name_regex="^user",
    output_file="users.txt",
    policy_name="AliyunACSDefaultAccess",
    policy_type="Custom")
pulumi.export("firstUserId", users_ds.users[0]["id"])

Parameters

group_name (str) – Filter results by a specific group name. Returned users are in the specified group.
ids (list) –
- A list of ram user IDs.
name_regex (str) – A regex string to filter resulting users by their names.
policy_name (str) – Filter results by a specific policy name. If you set this parameter without setting policy_type, the later will be automatically set to System. Returned users are attached to the specified policy.
policy_type (str) – Filter results by a specific policy type. Valid values are Custom and System. If you set this parameter, you must set policy_name as well.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

ram¶

On This Page