Skip to content

LoginProfile

This class encapsulates and extends the ROS resource type ALIYUN::RAM::LoginProfile.

Initializers

import com.aliyun.ros.cdk.ram.LoginProfile;
LoginProfile.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .userPrincipalName(java.lang.String)
    .userPrincipalName(IResolvable)
//  .generateRandomPassword(java.lang.Boolean)
//  .generateRandomPassword(IResolvable)
//  .mfaBindRequired(java.lang.Boolean)
//  .mfaBindRequired(IResolvable)
//  .password(java.lang.String)
//  .password(IResolvable)
//  .passwordResetRequired(java.lang.Boolean)
//  .passwordResetRequired(IResolvable)
//  .status(java.lang.String)
//  .status(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
userPrincipalName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property userPrincipalName: The login name of the RAM user.
generateRandomPassword java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property generateRandomPassword: Whether to generate a random password for the RAM user.
mfaBindRequired java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property mfaBindRequired: Whether to force RAM users to enable multi-factor authentication.
password java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property password: The logon password for the RAM user.
passwordResetRequired java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property passwordResetRequired: Whether RAM users must reset their password the next time they log in.
status java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property status: Specifies whether to enable password-based logon to the console.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

userPrincipalNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property userPrincipalName: The login name of the RAM user.


generateRandomPasswordOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property generateRandomPassword: Whether to generate a random password for the RAM user.


mfaBindRequiredOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property mfaBindRequired: Whether to force RAM users to enable multi-factor authentication.

Valid values:

  • true: This is required. RAM users must bind the multifactor authentication device the next time they log in.
  • false (default) : This is not required.

passwordOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property password: The logon password for the RAM user.

The password must meet the password policy.


passwordResetRequiredOptional

  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

Property passwordResetRequired: Whether RAM users must reset their password the next time they log in.


statusOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property status: Specifies whether to enable password-based logon to the console.

Valid values:

  • Active (default): Enable
  • Inactive: Disable

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.ram.LoginProfile;
LoginProfile.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrPassword java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Password: The password of the RAM user.
props LoginProfileProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrPasswordRequired

public java.lang.Object getAttrPassword();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Password: The password of the RAM user.


propsRequired

public LoginProfileProps getProps();