UserVpcAuthorization
- Implements: IUserVpcAuthorization
This class encapsulates and extends the ROS resource type ALIYUN::PVTZ::UserVpcAuthorization, which is used to associate virtual private clouds (VPCs) across accounts.
Initializers
import com.aliyun.ros.cdk.pvtz.UserVpcAuthorization;
UserVpcAuthorization.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.authorizedUserId(java.lang.String)
.authorizedUserId(IResolvable)
// .authChannel(java.lang.String)
// .authChannel(IResolvable)
// .authCode(java.lang.String)
// .authCode(IResolvable)
// .authType(java.lang.String)
// .authType(IResolvable)
// .ignoreDeletionForbidden(java.lang.Boolean)
// .ignoreDeletionForbidden(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. |
authorizedUserId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property authorizedUserId: The ID of the account that owns the authorized resources. |
authChannel | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property authChannel: Authorization channel. |
authCode | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property authCode: Verification code, if AuthChannel takes "AUTH_CODE" or is empty, it is mandatory. |
authType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property authType: The authorization type. |
ignoreDeletionForbidden | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property ignoreDeletionForbidden: Whether to ignore following deletion forbidden errors when deleting:- UserAuth.DeleteForbidden.ZoneVpcExists. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
authorizedUserIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property authorizedUserId: The ID of the account that owns the authorized resources.
Only cloud accounts are supported. RAM users are not supported. You can associate accounts only if they are on the same site. Cross-site association is not supported.
authChannelOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property authChannel: Authorization channel.
Valid values: AUTH_CODE: Verification code authorization, to verify whether the verification code passed in by AuthCode is correct. RESOURCE_DIRECTORY: Resource directory authorization, verify whether the AuthorizedUserId and the current account have resource directory credit.When it is empty, it is the same as AUTH_CODE, that is, verification code authorization.
authCodeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property authCode: Verification code, if AuthChannel takes "AUTH_CODE" or is empty, it is mandatory.
authTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property authType: The authorization type.
Valid values:
- NORMAL: standard authorization.
- CLOUD_PRODUCT: cloud product authorization.
ignoreDeletionForbiddenOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property ignoreDeletionForbidden: Whether to ignore following deletion forbidden errors when deleting:- UserAuth.DeleteForbidden.ZoneVpcExists.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.pvtz.UserVpcAuthorization;
UserVpcAuthorization.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrAuthorizedUserId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AuthorizedUserId: The account ID of the user who authorizes the resource. |
attrAuthType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AuthType: Authorization type. |
props | UserVpcAuthorizationProps | 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
attrAuthorizedUserIdRequired
public java.lang.Object getAttrAuthorizedUserId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AuthorizedUserId: The account ID of the user who authorizes the resource.
attrAuthTypeRequired
public java.lang.Object getAttrAuthType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AuthType: Authorization type.
propsRequired
public UserVpcAuthorizationProps getProps();