86 lines
3.1 KiB
TypeScript
86 lines
3.1 KiB
TypeScript
import * as cdk from "../../core/lib";
|
|
import * as constructs from "constructs";
|
|
import * as cfn_parse from "../../core/lib/helpers-internal";
|
|
import { DomainReference, IDomainRef } from "../../interfaces/generated/aws-sdb-interfaces.generated";
|
|
/**
|
|
* Use the `AWS::SDB::Domain` resource to declare a SimpleDB domain.
|
|
*
|
|
* When you specify `AWS::SDB::Domain` as an argument in a `Ref` function, AWS CloudFormation returns the value of the `DomainName` .
|
|
*
|
|
* > The `AWS::SDB::Domain` resource does not allow any updates, including metadata updates.
|
|
*
|
|
* @cloudformationResource AWS::SDB::Domain
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sdb-domain.html
|
|
*/
|
|
export declare class CfnDomain extends cdk.CfnResource implements cdk.IInspectable, IDomainRef {
|
|
/**
|
|
* The CloudFormation resource type name for this resource class.
|
|
*/
|
|
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
|
/**
|
|
* Build a CfnDomain from CloudFormation properties
|
|
*
|
|
* A factory method that creates a new instance of this class from an object
|
|
* containing the CloudFormation properties of this resource.
|
|
* Used in the @aws-cdk/cloudformation-include module.
|
|
*
|
|
* @internal
|
|
*/
|
|
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDomain;
|
|
/**
|
|
* Checks whether the given object is a CfnDomain
|
|
*/
|
|
static isCfnDomain(x: any): x is CfnDomain;
|
|
/**
|
|
* Information about the SimpleDB domain.
|
|
*/
|
|
private _description?;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::SDB::Domain`.
|
|
*
|
|
* @param scope Scope in which this resource is defined
|
|
* @param id Construct identifier for this resource (unique in its scope)
|
|
* @param props Resource properties
|
|
*/
|
|
constructor(scope: constructs.Construct, id: string, props?: CfnDomainProps);
|
|
get domainRef(): DomainReference;
|
|
/**
|
|
* Information about the SimpleDB domain.
|
|
*/
|
|
get description(): string | undefined;
|
|
/**
|
|
* Information about the SimpleDB domain.
|
|
*/
|
|
set description(value: string | undefined);
|
|
/**
|
|
* @cloudformationAttribute Id
|
|
*/
|
|
get attrId(): string;
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnDomain`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sdb-domain.html
|
|
*/
|
|
export interface CfnDomainProps {
|
|
/**
|
|
* Information about the SimpleDB domain.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sdb-domain.html#cfn-sdb-domain-description
|
|
*/
|
|
readonly description?: string;
|
|
}
|
|
export type { IDomainRef, DomainReference };
|