Page
- Implements: IPage
This class encapsulates and extends the ROS resource type ALIYUN::ESA::PageThe , which type is used to create a custom response page.
Initializers
import com.aliyun.ros.cdk.esa.Page;
Page.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.contentType(java.lang.String)
.contentType(IResolvable)
.pageName(java.lang.String)
.pageName(IResolvable)
// .content(java.lang.String)
// .content(IResolvable)
// .description(java.lang.String)
// .description(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. |
contentType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property contentType: The Content-Type field in the HTTP header. |
pageName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property pageName: The name of the custom response page. |
content | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property content: The Base64-encoded page content. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The description of the page. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
contentTypeRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property contentType: The Content-Type field in the HTTP header.
Valid values: text/html application/json
pageNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property pageName: The name of the custom response page.
contentOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property content: The Base64-encoded page content.
Example: "PGh0bWw+aGVsbG8gcGFnZTwvaHRtbD4=", which indicates "hello page".
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the page.
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.Page;
Page.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. |
attrContent | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Content: The Base64-encoded content of the error page. |
attrContentType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ContentType: The Content-Type field in the HTTP header. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The description of the custom error page. |
attrKind | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Kind: The type of the custom response page. |
attrPageId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PageId: The ID of the custom error page. |
attrPageName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PageName: The name of the custom response page. |
attrUpdateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute UpdateTime: The time when the custom error page was last modified. |
props | PageProps | 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
attrContentRequired
public java.lang.Object getAttrContent();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Content: The Base64-encoded content of the error page.
The content type is specified by the Content-Type field.
attrContentTypeRequired
public java.lang.Object getAttrContentType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ContentType: The Content-Type field in the HTTP header.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The description of the custom error page.
attrKindRequired
public java.lang.Object getAttrKind();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Kind: The type of the custom response page.
attrPageIdRequired
public java.lang.Object getAttrPageId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PageId: The ID of the custom error page.
attrPageNameRequired
public java.lang.Object getAttrPageName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PageName: The name of the custom response page.
attrUpdateTimeRequired
public java.lang.Object getAttrUpdateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute UpdateTime: The time when the custom error page was last modified.
propsRequired
public PageProps getProps();
- Type: PageProps