Skip to content

AccessControl

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::AccessControl.

Initializers

import com.aliyun.ros.cdk.apigateway.AccessControl;
AccessControl.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .accessControlListName(java.lang.String)
    .accessControlListName(IResolvable)
//  .aclEntrys(IResolvable)
//  .aclEntrys(java.util.List<IResolvable)
//  .aclEntrys(AclEntrysProperty>)
//  .addressIpVersion(java.lang.String)
//  .addressIpVersion(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.
accessControlListName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accessControlListName: The name of the ACL.
aclEntrys com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAclEntrysProperty> Property aclEntrys: Information list of access control policies.
addressIpVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property addressIpVersion: The IP version.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

accessControlListNameRequired

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

Property accessControlListName: The name of the ACL.

The name must be 1 to 30 characters in length, and can contain letters, digits, periods (.), hyphens (-), forward slashes (/), and underscores (_). The name must be unique within the region.


aclEntrysOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListAclEntrysProperty>

Property aclEntrys: Information list of access control policies.

You can add at most 50 IP addresses or CIDR blocks to an ACL in each call. If the IP address or CIDR block that you want to add to an ACL already exists, the IP address or CIDR block is not added. The entries that you add must be CIDR blocks.


addressIpVersionOptional

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

Property addressIpVersion: The IP version.

Valid values: ipv4 and ipv6.


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.apigateway.AccessControl;
AccessControl.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.
attrAccessControlListName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AccessControlListName: The name of the ACL.
attrAclEntrys java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AclEntrys: Information list of access control policies.
attrAclId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AclId: The ID of the access control list (ACL).
attrAddressIpVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AddressIpVersion: The IP version.
props AccessControlProps 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

attrAccessControlListNameRequired

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

Attribute AccessControlListName: The name of the ACL.


attrAclEntrysRequired

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

Attribute AclEntrys: Information list of access control policies.


attrAclIdRequired

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

Attribute AclId: The ID of the access control list (ACL).


attrAddressIpVersionRequired

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

Attribute AddressIpVersion: The IP version.

Valid values: ipv4 and ipv6.


propsRequired

public AccessControlProps getProps();