Files
agent-claw/cdk/node_modules/aws-cdk-lib/aws-directoryservice/lib/directoryservice.generated.d.ts
2026-05-06 18:55:16 -05:00

519 lines
23 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { IMicrosoftADRef, ISimpleADRef, MicrosoftADReference, SimpleADReference } from "../../interfaces/generated/aws-directoryservice-interfaces.generated";
/**
* The `AWS::DirectoryService::MicrosoftAD` resource specifies a Microsoft Active Directory in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials.
*
* For more information, see [AWS Managed Microsoft AD](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_microsoft_ad.html) in the *Directory Service Admin Guide* .
*
* @cloudformationResource AWS::DirectoryService::MicrosoftAD
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html
*/
export declare class CfnMicrosoftAD extends cdk.CfnResource implements cdk.IInspectable, IMicrosoftADRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnMicrosoftAD 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): CfnMicrosoftAD;
/**
* Checks whether the given object is a CfnMicrosoftAD
*/
static isCfnMicrosoftAD(x: any): x is CfnMicrosoftAD;
/**
* Specifies an alias for a directory and assigns the alias to the directory.
*/
private _createAlias?;
/**
* AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
*/
private _edition?;
/**
* Whether to enable single sign-on for a Microsoft Active Directory in AWS .
*/
private _enableSso?;
/**
* The fully qualified domain name for the AWS Managed Microsoft AD directory, such as `corp.example.com` . This name will resolve inside your VPC only. It does not need to be publicly resolvable.
*/
private _name;
/**
* The password for the default administrative user named `Admin` .
*/
private _password;
/**
* The NetBIOS name for your domain, such as `CORP` .
*/
private _shortName?;
/**
* Specifies the VPC settings of the Microsoft AD directory server in AWS .
*/
private _vpcSettings;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::DirectoryService::MicrosoftAD`.
*
* @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: CfnMicrosoftADProps);
get microsoftAdRef(): MicrosoftADReference;
/**
* Specifies an alias for a directory and assigns the alias to the directory.
*/
get createAlias(): boolean | cdk.IResolvable | undefined;
/**
* Specifies an alias for a directory and assigns the alias to the directory.
*/
set createAlias(value: boolean | cdk.IResolvable | undefined);
/**
* AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
*/
get edition(): string | undefined;
/**
* AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
*/
set edition(value: string | undefined);
/**
* Whether to enable single sign-on for a Microsoft Active Directory in AWS .
*/
get enableSso(): boolean | cdk.IResolvable | undefined;
/**
* Whether to enable single sign-on for a Microsoft Active Directory in AWS .
*/
set enableSso(value: boolean | cdk.IResolvable | undefined);
/**
* The fully qualified domain name for the AWS Managed Microsoft AD directory, such as `corp.example.com` . This name will resolve inside your VPC only. It does not need to be publicly resolvable.
*/
get name(): string;
/**
* The fully qualified domain name for the AWS Managed Microsoft AD directory, such as `corp.example.com` . This name will resolve inside your VPC only. It does not need to be publicly resolvable.
*/
set name(value: string);
/**
* The password for the default administrative user named `Admin` .
*/
get password(): string;
/**
* The password for the default administrative user named `Admin` .
*/
set password(value: string);
/**
* The NetBIOS name for your domain, such as `CORP` .
*/
get shortName(): string | undefined;
/**
* The NetBIOS name for your domain, such as `CORP` .
*/
set shortName(value: string | undefined);
/**
* Specifies the VPC settings of the Microsoft AD directory server in AWS .
*/
get vpcSettings(): cdk.IResolvable | CfnMicrosoftAD.VpcSettingsProperty;
/**
* Specifies the VPC settings of the Microsoft AD directory server in AWS .
*/
set vpcSettings(value: cdk.IResolvable | CfnMicrosoftAD.VpcSettingsProperty);
/**
* The alias for a directory. For example: `alias4-mydirectory-12345abcgmzsk` (if you have the `CreateAlias` property set to true).
*
* @cloudformationAttribute Alias
*/
get attrAlias(): string;
/**
* The IP addresses of the DNS servers for the directory, such as `[ "192.0.2.1", "192.0.2.2" ]` .
*
* @cloudformationAttribute DnsIpAddresses
*/
get attrDnsIpAddresses(): Array<string>;
/**
* The directory ID. For example: `d-12373a053a` .
*
* @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>;
}
export declare namespace CfnMicrosoftAD {
/**
* Contains VPC information for the [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) or [CreateMicrosoftAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html) operation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html
*/
interface VpcSettingsProperty {
/**
* The identifiers of the subnets for the directory servers.
*
* The two subnets must be in different Availability Zones. Directory Service specifies a directory server and a DNS server in each of these subnets.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html#cfn-directoryservice-microsoftad-vpcsettings-subnetids
*/
readonly subnetIds: Array<string>;
/**
* The identifier of the VPC in which to create the directory.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-microsoftad-vpcsettings.html#cfn-directoryservice-microsoftad-vpcsettings-vpcid
*/
readonly vpcId: string;
}
}
/**
* Properties for defining a `CfnMicrosoftAD`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html
*/
export interface CfnMicrosoftADProps {
/**
* Specifies an alias for a directory and assigns the alias to the directory.
*
* The alias is used to construct the access URL for the directory, such as `http://<alias>.awsapps.com` . By default, CloudFormation does not create an alias.
*
* > After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-createalias
*/
readonly createAlias?: boolean | cdk.IResolvable;
/**
* AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
*
* `Enterprise` is the default.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-edition
*/
readonly edition?: string;
/**
* Whether to enable single sign-on for a Microsoft Active Directory in AWS .
*
* Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. If you don't specify a value, CloudFormation disables single sign-on by default.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-enablesso
*/
readonly enableSso?: boolean | cdk.IResolvable;
/**
* The fully qualified domain name for the AWS Managed Microsoft AD directory, such as `corp.example.com` . This name will resolve inside your VPC only. It does not need to be publicly resolvable.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-name
*/
readonly name: string;
/**
* The password for the default administrative user named `Admin` .
*
* If you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *Directory Service API Reference* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-password
*/
readonly password: string;
/**
* The NetBIOS name for your domain, such as `CORP` .
*
* If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, `CORP` for the directory DNS `corp.example.com` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-shortname
*/
readonly shortName?: string;
/**
* Specifies the VPC settings of the Microsoft AD directory server in AWS .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-microsoftad.html#cfn-directoryservice-microsoftad-vpcsettings
*/
readonly vpcSettings: cdk.IResolvable | CfnMicrosoftAD.VpcSettingsProperty;
}
/**
* The `AWS::DirectoryService::SimpleAD` resource specifies an Directory Service Simple Active Directory ( Simple AD ) in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials.
*
* Simple AD is a Microsoft Active Directorycompatible directory. For more information, see [Simple Active Directory](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) in the *Directory Service Admin Guide* .
*
* @cloudformationResource AWS::DirectoryService::SimpleAD
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html
*/
export declare class CfnSimpleAD extends cdk.CfnResource implements cdk.IInspectable, ISimpleADRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnSimpleAD 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): CfnSimpleAD;
/**
* Checks whether the given object is a CfnSimpleAD
*/
static isCfnSimpleAD(x: any): x is CfnSimpleAD;
/**
* Creates a new ISimpleADRef from a directoryId
*/
static fromDirectoryId(scope: constructs.Construct, id: string, directoryId: string): ISimpleADRef;
static arnForSimpleAD(resource: ISimpleADRef): string;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* If set to `true` , specifies an alias for a directory and assigns the alias to the directory.
*/
private _createAlias?;
/**
* A description for the directory.
*/
private _description?;
/**
* Whether to enable single sign-on for a directory.
*/
private _enableSso?;
/**
* The fully qualified name for the directory, such as `corp.example.com` .
*/
private _name;
/**
* The password for the directory administrator.
*/
private _password?;
/**
* The NetBIOS name of the directory, such as `CORP` .
*/
private _shortName?;
/**
* The size of the directory.
*/
private _size;
private _tags?;
/**
* A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
*/
private _vpcSettings;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::DirectoryService::SimpleAD`.
*
* @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: CfnSimpleADProps);
get simpleAdRef(): SimpleADReference;
/**
* If set to `true` , specifies an alias for a directory and assigns the alias to the directory.
*/
get createAlias(): boolean | cdk.IResolvable | undefined;
/**
* If set to `true` , specifies an alias for a directory and assigns the alias to the directory.
*/
set createAlias(value: boolean | cdk.IResolvable | undefined);
/**
* A description for the directory.
*/
get description(): string | undefined;
/**
* A description for the directory.
*/
set description(value: string | undefined);
/**
* Whether to enable single sign-on for a directory.
*/
get enableSso(): boolean | cdk.IResolvable | undefined;
/**
* Whether to enable single sign-on for a directory.
*/
set enableSso(value: boolean | cdk.IResolvable | undefined);
/**
* The fully qualified name for the directory, such as `corp.example.com` .
*/
get name(): string;
/**
* The fully qualified name for the directory, such as `corp.example.com` .
*/
set name(value: string);
/**
* The password for the directory administrator.
*/
get password(): string | undefined;
/**
* The password for the directory administrator.
*/
set password(value: string | undefined);
/**
* The NetBIOS name of the directory, such as `CORP` .
*/
get shortName(): string | undefined;
/**
* The NetBIOS name of the directory, such as `CORP` .
*/
set shortName(value: string | undefined);
/**
* The size of the directory.
*/
get size(): string;
/**
* The size of the directory.
*/
set size(value: string);
get tags(): Array<cdk.CfnTag> | undefined;
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
*/
get vpcSettings(): cdk.IResolvable | CfnSimpleAD.VpcSettingsProperty;
/**
* A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
*/
set vpcSettings(value: cdk.IResolvable | CfnSimpleAD.VpcSettingsProperty);
/**
* The alias for a directory. For example: `alias4-mydirectory-12345abcgmzsk` (if you have the `CreateAlias` property set to true).
*
* @cloudformationAttribute Alias
*/
get attrAlias(): string;
/**
* The directory ID. For example: `d-12373a053a` .
*
* @cloudformationAttribute DirectoryId
*/
get attrDirectoryId(): string;
/**
* The IP addresses of the DNS servers for the directory, such as `[ "172.31.3.154", "172.31.63.203" ]` .
*
* @cloudformationAttribute DnsIpAddresses
*/
get attrDnsIpAddresses(): Array<string>;
/**
* @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>;
}
export declare namespace CfnSimpleAD {
/**
* Contains VPC information for the [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) or [CreateMicrosoftAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html) operation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html
*/
interface VpcSettingsProperty {
/**
* The identifiers of the subnets for the directory servers.
*
* The two subnets must be in different Availability Zones. Directory Service specifies a directory server and a DNS server in each of these subnets.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html#cfn-directoryservice-simplead-vpcsettings-subnetids
*/
readonly subnetIds: Array<string>;
/**
* The identifier of the VPC in which to create the directory.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-directoryservice-simplead-vpcsettings.html#cfn-directoryservice-simplead-vpcsettings-vpcid
*/
readonly vpcId: string;
}
}
/**
* Properties for defining a `CfnSimpleAD`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html
*/
export interface CfnSimpleADProps {
/**
* If set to `true` , specifies an alias for a directory and assigns the alias to the directory.
*
* The alias is used to construct the access URL for the directory, such as `http://<alias>.awsapps.com` . By default, this property is set to `false` .
*
* > After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-createalias
*/
readonly createAlias?: boolean | cdk.IResolvable;
/**
* A description for the directory.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-description
*/
readonly description?: string;
/**
* Whether to enable single sign-on for a directory.
*
* If you don't specify a value, CloudFormation disables single sign-on by default.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-enablesso
*/
readonly enableSso?: boolean | cdk.IResolvable;
/**
* The fully qualified name for the directory, such as `corp.example.com` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-name
*/
readonly name: string;
/**
* The password for the directory administrator.
*
* The directory creation process creates a directory administrator account with the user name `Administrator` and this password.
*
* If you need to change the password for the administrator account, see the [ResetUserPassword](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_ResetUserPassword.html) API call in the *Directory Service API Reference* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-password
*/
readonly password?: string;
/**
* The NetBIOS name of the directory, such as `CORP` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-shortname
*/
readonly shortName?: string;
/**
* The size of the directory.
*
* For valid values, see [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in the *Directory Service API Reference* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-size
*/
readonly size: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-vpcsettings
*/
readonly vpcSettings: cdk.IResolvable | CfnSimpleAD.VpcSettingsProperty;
}
export type { IMicrosoftADRef, MicrosoftADReference };
export type { ISimpleADRef, SimpleADReference };