Skip to content

AddressBook

  • Implements: @alicloud/ros-cdk-cloudfw.datasource.IAddressBook

This class encapsulates and extends the ROS resource type DATASOURCE::CLOUDFW::AddressBook, which is used to query the information about an address book for access control in Cloud Firewall.

Initializers

import { datasource } from '@alicloud/ros-cdk-cloudfw'
new datasource.AddressBook(scope: Construct, id: string, props: AddressBookProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props AddressBookProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import { datasource } from '@alicloud/ros-cdk-cloudfw'
datasource.AddressBook.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAddressList string | @alicloud/ros-cdk-core.IResolvable Attribute AddressList: The addresses in the address book.
attrAddressListCount string | @alicloud/ros-cdk-core.IResolvable Attribute AddressListCount: The number of addresses in the address book.
attrAutoAddTagEcs string | @alicloud/ros-cdk-core.IResolvable Attribute AutoAddTagEcs: Indicates whether the public IP addresses of ECS instances are automatically added to the address book if the instances match the specified tags.
attrDescription string | @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the address book.
attrGroupName string | @alicloud/ros-cdk-core.IResolvable Attribute GroupName: The name of the address book.
attrGroupType string | @alicloud/ros-cdk-core.IResolvable Attribute GroupType: The type of the address book.
attrGroupUuid string | @alicloud/ros-cdk-core.IResolvable Attribute GroupUuid: The UUID of the address book.
attrReferenceCount string | @alicloud/ros-cdk-core.IResolvable Attribute ReferenceCount: The number of times that the address book is referenced.
attrTagRelation string | @alicloud/ros-cdk-core.IResolvable Attribute TagRelation: The logical relationship among ECS tags.
attrTags string | @alicloud/ros-cdk-core.IResolvable Attribute Tags: The details about the ECS tags that can be automatically added to the address book.
props AddressBookProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/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 readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAddressListRequired

public readonly attrAddressList: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AddressList: The addresses in the address book.


attrAddressListCountRequired

public readonly attrAddressListCount: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AddressListCount: The number of addresses in the address book.


attrAutoAddTagEcsRequired

public readonly attrAutoAddTagEcs: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute AutoAddTagEcs: Indicates whether the public IP addresses of ECS instances are automatically added to the address book if the instances match the specified tags.


attrDescriptionRequired

public readonly attrDescription: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the address book.


attrGroupNameRequired

public readonly attrGroupName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute GroupName: The name of the address book.


attrGroupTypeRequired

public readonly attrGroupType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute GroupType: The type of the address book.


attrGroupUuidRequired

public readonly attrGroupUuid: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute GroupUuid: The UUID of the address book.


attrReferenceCountRequired

public readonly attrReferenceCount: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute ReferenceCount: The number of times that the address book is referenced.


attrTagRelationRequired

public readonly attrTagRelation: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute TagRelation: The logical relationship among ECS tags.


attrTagsRequired

public readonly attrTags: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Tags: The details about the ECS tags that can be automatically added to the address book.


propsRequired

public readonly props: AddressBookProps;