CustomScenePolicy
- Implements: ICustomScenePolicy
This class encapsulates and extends the ROS resource type ALIYUN::ESA::CustomScenePolicy.
Initializers
import com.aliyun.ros.cdk.esa.CustomScenePolicy;
CustomScenePolicy.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.createTime(java.lang.String)
.createTime(IResolvable)
.customScenePolicyName(java.lang.String)
.customScenePolicyName(IResolvable)
.endTime(java.lang.String)
.endTime(IResolvable)
.objects(java.lang.String)
.objects(IResolvable)
.template(java.lang.String)
.template(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. |
createTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property createTime: The time when the policy takes effect. |
customScenePolicyName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property customScenePolicyName: The policy name. |
endTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property endTime: The time when the policy expires. |
objects | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property objects: The IDs of the websites that you want to associate with the policy. |
template | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property template: The name of the policy template. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
createTimeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property createTime: The time when the policy takes effect.
The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
customScenePolicyNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property customScenePolicyName: The policy name.
endTimeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property endTime: The time when the policy expires.
The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
objectsRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property objects: The IDs of the websites that you want to associate with the policy.
Separate multiple IDs with commas (,).
templateRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property template: The name of the policy template.
Valid value: promotion: major events.
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.esa.CustomScenePolicy;
CustomScenePolicy.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. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the policy takes effect. |
attrCustomScenePolicyName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CustomScenePolicyName: The name of the policy. |
attrEndTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EndTime: The time when the policy expires. |
attrObjects | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Objects: The IDs of websites associated. |
attrPolicyId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PolicyId: The Id of the Policy. |
attrTemplate | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Template: The name of the policy template. |
props | CustomScenePolicyProps | 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
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the policy takes effect.
attrCustomScenePolicyNameRequired
public java.lang.Object getAttrCustomScenePolicyName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CustomScenePolicyName: The name of the policy.
attrEndTimeRequired
public java.lang.Object getAttrEndTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EndTime: The time when the policy expires.
attrObjectsRequired
public java.lang.Object getAttrObjects();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Objects: The IDs of websites associated.
attrPolicyIdRequired
public java.lang.Object getAttrPolicyId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PolicyId: The Id of the Policy.
attrTemplateRequired
public java.lang.Object getAttrTemplate();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Template: The name of the policy template.
propsRequired
public CustomScenePolicyProps getProps();
- Type: CustomScenePolicyProps