SecurityGroup
- Implements: ISecurityGroup
This class encapsulates and extends the ROS resource type ALIYUN::ECS::SecurityGroup.
Initializers
import com.aliyun.ros.cdk.ecs.SecurityGroup;
SecurityGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
// .description(java.lang.String)
// .description(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .securityGroupEgress(IResolvable)
// .securityGroupEgress(java.util.List<IResolvable)
// .securityGroupEgress(SecurityGroupEgressProperty>)
// .securityGroupIngress(IResolvable)
// .securityGroupIngress(java.util.List<IResolvable)
// .securityGroupIngress(SecurityGroupIngressProperty>)
// .securityGroupName(java.lang.String)
// .securityGroupName(IResolvable)
// .securityGroupType(java.lang.String)
// .securityGroupType(IResolvable)
// .tags(java.util.List<TagsProperty>)
// .vpcId(java.lang.String)
// .vpcId(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. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the security group. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: Resource group id. |
securityGroupEgress | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property securityGroupEgress: egress rules for the security group. |
securityGroupIngress | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property securityGroupIngress: Ingress rules for the security group. |
securityGroupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property securityGroupName: The name of the security group. |
securityGroupType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property securityGroupType: The type of the security group. |
tags | java.util.List<TagsProperty> | Property tags: Tags to attach to security group. |
vpcId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vpcId: The ID of the VPC in which you want to create the security group. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the security group.
The description must be 2 to 256 characters in length. It cannot start with http:\/\/ or https:\/\/. By default, this parameter is left empty.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: Resource group id.
securityGroupEgressOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
SecurityGroupEgressProperty>
Property securityGroupEgress: egress rules for the security group.
securityGroupIngressOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
SecurityGroupIngressProperty>
Property securityGroupIngress: Ingress rules for the security group.
securityGroupNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property securityGroupName: The name of the security group.
The name must be 2 to 128 characters in length. The name must start with a letter and cannot start with http:\/\/ or https:\/\/. The name can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).
securityGroupTypeOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property securityGroupType: The type of the security group.
Valid values:
- normal: basic security group
- enterprise: advanced security group Default value: normal.
tagsOptional
- Type: java.util.List<TagsProperty>
Property tags: Tags to attach to security group.
Max support 20 tags to add during create security group. Each tag with two properties Key and Value, and Key is required.
vpcIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vpcId: The ID of the VPC in which you want to create the security group.
The VpcId parameter is required only if you want to create security groups of the VPC type.
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.ecs.SecurityGroup;
SecurityGroup.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. |
attrSecurityGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecurityGroupId: generated security group id for security group. |
attrSecurityGroupName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SecurityGroupName: The name of security group. |
props | SecurityGroupProps | 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
attrSecurityGroupIdRequired
public java.lang.Object getAttrSecurityGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecurityGroupId: generated security group id for security group.
attrSecurityGroupNameRequired
public java.lang.Object getAttrSecurityGroupName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SecurityGroupName: The name of security group.
propsRequired
public SecurityGroupProps getProps();
- Type: SecurityGroupProps