awsdirectoryservice

package
v2.19.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 1, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnMicrosoftAD_CFN_RESOURCE_TYPE_NAME

func CfnMicrosoftAD_CFN_RESOURCE_TYPE_NAME() *string

func CfnMicrosoftAD_IsCfnElement

func CfnMicrosoftAD_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnMicrosoftAD_IsCfnResource

func CfnMicrosoftAD_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnMicrosoftAD_IsConstruct

func CfnMicrosoftAD_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func CfnSimpleAD_CFN_RESOURCE_TYPE_NAME

func CfnSimpleAD_CFN_RESOURCE_TYPE_NAME() *string

func CfnSimpleAD_IsCfnElement

func CfnSimpleAD_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnSimpleAD_IsCfnResource

func CfnSimpleAD_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSimpleAD_IsConstruct

func CfnSimpleAD_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead.

func NewCfnMicrosoftAD_Override

func NewCfnMicrosoftAD_Override(c CfnMicrosoftAD, scope constructs.Construct, id *string, props *CfnMicrosoftADProps)

Create a new `AWS::DirectoryService::MicrosoftAD`.

func NewCfnSimpleAD_Override

func NewCfnSimpleAD_Override(c CfnSimpleAD, scope constructs.Construct, id *string, props *CfnSimpleADProps)

Create a new `AWS::DirectoryService::SimpleAD`.

Types

type CfnMicrosoftAD

type CfnMicrosoftAD interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The alias for a directory.
	//
	// For example: `d-12373a053a` or `alias4-mydirectory-12345abcgmzsk` (if you have the `CreateAlias` property set to true).
	AttrAlias() *string
	// The IP addresses of the DNS servers for the directory, such as `[ "192.0.2.1", "192.0.2.2" ]` .
	AttrDnsIpAddresses() *[]*string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// 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, AWS 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.
	CreateAlias() interface{}
	SetCreateAlias(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
	//
	// `Enterprise` is the default.
	Edition() *string
	SetEdition(val *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, AWS CloudFormation disables single sign-on by default.
	EnableSso() interface{}
	SetEnableSso(val interface{})
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *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.
	Name() *string
	SetName(val *string)
	// The tree node.
	Node() constructs.Node
	// 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 *AWS Directory Service API Reference* .
	Password() *string
	SetPassword(val *string)
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *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` .
	ShortName() *string
	SetShortName(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// Specifies the VPC settings of the Microsoft AD directory server in AWS .
	VpcSettings() interface{}
	SetVpcSettings(val interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::DirectoryService::MicrosoftAD`.

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 *AWS Directory Service Admin Guide* .

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import directoryservice "github.com/aws/aws-cdk-go/awscdk/aws_directoryservice"
cfnMicrosoftAD := directoryservice.NewCfnMicrosoftAD(this, jsii.String("MyCfnMicrosoftAD"), &cfnMicrosoftADProps{
	name: jsii.String("name"),
	password: jsii.String("password"),
	vpcSettings: &vpcSettingsProperty{
		subnetIds: []*string{
			jsii.String("subnetIds"),
		},
		vpcId: jsii.String("vpcId"),
	},

	// the properties below are optional
	createAlias: jsii.Boolean(false),
	edition: jsii.String("edition"),
	enableSso: jsii.Boolean(false),
	shortName: jsii.String("shortName"),
})

func NewCfnMicrosoftAD

func NewCfnMicrosoftAD(scope constructs.Construct, id *string, props *CfnMicrosoftADProps) CfnMicrosoftAD

Create a new `AWS::DirectoryService::MicrosoftAD`.

type CfnMicrosoftADProps

type CfnMicrosoftADProps struct {
	// 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.
	Name *string `json:"name" yaml:"name"`
	// 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 *AWS Directory Service API Reference* .
	Password *string `json:"password" yaml:"password"`
	// Specifies the VPC settings of the Microsoft AD directory server in AWS .
	VpcSettings interface{} `json:"vpcSettings" yaml:"vpcSettings"`
	// 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, AWS 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.
	CreateAlias interface{} `json:"createAlias" yaml:"createAlias"`
	// AWS Managed Microsoft AD is available in two editions: `Standard` and `Enterprise` .
	//
	// `Enterprise` is the default.
	Edition *string `json:"edition" yaml:"edition"`
	// 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, AWS CloudFormation disables single sign-on by default.
	EnableSso interface{} `json:"enableSso" yaml:"enableSso"`
	// 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` .
	ShortName *string `json:"shortName" yaml:"shortName"`
}

Properties for defining a `CfnMicrosoftAD`.

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import directoryservice "github.com/aws/aws-cdk-go/awscdk/aws_directoryservice"
cfnMicrosoftADProps := &cfnMicrosoftADProps{
	name: jsii.String("name"),
	password: jsii.String("password"),
	vpcSettings: &vpcSettingsProperty{
		subnetIds: []*string{
			jsii.String("subnetIds"),
		},
		vpcId: jsii.String("vpcId"),
	},

	// the properties below are optional
	createAlias: jsii.Boolean(false),
	edition: jsii.String("edition"),
	enableSso: jsii.Boolean(false),
	shortName: jsii.String("shortName"),
}

type CfnMicrosoftAD_VpcSettingsProperty

type CfnMicrosoftAD_VpcSettingsProperty struct {
	// The identifiers of the subnets for the directory servers.
	//
	// The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
	SubnetIds *[]*string `json:"subnetIds" yaml:"subnetIds"`
	// The identifier of the VPC in which to create the directory.
	VpcId *string `json:"vpcId" yaml:"vpcId"`
}

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.

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import directoryservice "github.com/aws/aws-cdk-go/awscdk/aws_directoryservice"
vpcSettingsProperty := &vpcSettingsProperty{
	subnetIds: []*string{
		jsii.String("subnetIds"),
	},
	vpcId: jsii.String("vpcId"),
}

type CfnSimpleAD

type CfnSimpleAD interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The alias for a directory.
	//
	// For example: `d-12373a053a` or `alias4-mydirectory-12345abcgmzsk` (if you have the `CreateAlias` property set to true).
	AttrAlias() *string
	// The IP addresses of the DNS servers for the directory, such as `[ "172.31.3.154", "172.31.63.203" ]` .
	AttrDnsIpAddresses() *[]*string
	// Options for this resource, such as condition, update policy etc.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	CfnResourceType() *string
	// 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.
	CreateAlias() interface{}
	SetCreateAlias(val interface{})
	// Returns: the stack trace of the point where this Resource was created from, sourced
	// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
	// node +internal+ entries filtered.
	CreationStack() *[]*string
	// A description for the directory.
	Description() *string
	SetDescription(val *string)
	// Whether to enable single sign-on for a directory.
	//
	// If you don't specify a value, AWS CloudFormation disables single sign-on by default.
	EnableSso() interface{}
	SetEnableSso(val interface{})
	// The logical ID for this CloudFormation stack element.
	//
	// The logical ID of the element
	// is calculated from the path of the resource node in the construct tree.
	//
	// To override this value, use `overrideLogicalId(newLogicalId)`.
	//
	// Returns: the logical ID as a stringified token. This value will only get
	// resolved during synthesis.
	LogicalId() *string
	// The fully qualified name for the directory, such as `corp.example.com` .
	Name() *string
	SetName(val *string)
	// The tree node.
	Node() constructs.Node
	// 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 *AWS Directory Service API Reference* .
	Password() *string
	SetPassword(val *string)
	// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
	//
	// If, by any chance, the intrinsic reference of a resource is not a string, you could
	// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
	Ref() *string
	// The NetBIOS name of the directory, such as `CORP` .
	ShortName() *string
	SetShortName(val *string)
	// The size of the directory.
	//
	// For valid values, see [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in the *AWS Directory Service API Reference* .
	Size() *string
	SetSize(val *string)
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	UpdatedProperites() *map[string]interface{}
	// A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
	VpcSettings() interface{}
	SetVpcSettings(val interface{})
	// Syntactic sugar for `addOverride(path, undefined)`.
	AddDeletionOverride(path *string)
	// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
	//
	// This can be used for resources across stacks (or nested stack) boundaries
	// and the dependency will automatically be transferred to the relevant scope.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` with
	// "Properties." (i.e. `Properties.TopicName`).
	//
	// If the override is nested, separate each nested level using a dot (.) in the path parameter.
	// If there is an array as part of the nesting, specify the index in the path.
	//
	// To include a literal `.` in the property name, prefix with a `\`. In most
	// programming languages you will need to write this as `"\\."` because the
	// `\` itself will need to be escaped.
	//
	// For example,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` will not be processed or translated
	// in any way. Pass raw JSON values in here with the correct capitalization
	// for CloudFormation. If you pass CDK classes or structs, they will be
	// rendered with lowercased key names, and CloudFormation will reject the
	// template.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	AddPropertyOverride(propertyPath *string, value interface{})
	// Sets the deletion policy of the resource based on the removal policy specified.
	//
	// The Removal Policy controls what happens to this resource when it stops
	// being managed by CloudFormation, either because you've removed it from the
	// CDK application or because you've made a change that requires the resource
	// to be replaced.
	//
	// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
	// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// Returns a token for an runtime attribute of this resource.
	//
	// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
	// in case there is no generated attribute.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
	//
	// Note that this is a different set of metadata from CDK node metadata; this
	// metadata ends up in the stack template under the resource, whereas CDK
	// node metadata ends up in the Cloud Assembly.
	//
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Overrides the auto-generated logical ID with a specific ID.
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	ShouldSynthesize() *bool
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::DirectoryService::SimpleAD`.

The `AWS::DirectoryService::SimpleAD` resource specifies an AWS 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 Directory–compatible directory. For more information, see [Simple Active Directory](https://docs.aws.amazon.com/directoryservice/latest/admin-guide/directory_simple_ad.html) in the *AWS Directory Service Admin Guide* .

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import directoryservice "github.com/aws/aws-cdk-go/awscdk/aws_directoryservice"
cfnSimpleAD := directoryservice.NewCfnSimpleAD(this, jsii.String("MyCfnSimpleAD"), &cfnSimpleADProps{
	name: jsii.String("name"),
	password: jsii.String("password"),
	size: jsii.String("size"),
	vpcSettings: &vpcSettingsProperty{
		subnetIds: []*string{
			jsii.String("subnetIds"),
		},
		vpcId: jsii.String("vpcId"),
	},

	// the properties below are optional
	createAlias: jsii.Boolean(false),
	description: jsii.String("description"),
	enableSso: jsii.Boolean(false),
	shortName: jsii.String("shortName"),
})

func NewCfnSimpleAD

func NewCfnSimpleAD(scope constructs.Construct, id *string, props *CfnSimpleADProps) CfnSimpleAD

Create a new `AWS::DirectoryService::SimpleAD`.

type CfnSimpleADProps

type CfnSimpleADProps struct {
	// The fully qualified name for the directory, such as `corp.example.com` .
	Name *string `json:"name" yaml:"name"`
	// 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 *AWS Directory Service API Reference* .
	Password *string `json:"password" yaml:"password"`
	// The size of the directory.
	//
	// For valid values, see [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) in the *AWS Directory Service API Reference* .
	Size *string `json:"size" yaml:"size"`
	// A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
	VpcSettings interface{} `json:"vpcSettings" yaml:"vpcSettings"`
	// 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.
	CreateAlias interface{} `json:"createAlias" yaml:"createAlias"`
	// A description for the directory.
	Description *string `json:"description" yaml:"description"`
	// Whether to enable single sign-on for a directory.
	//
	// If you don't specify a value, AWS CloudFormation disables single sign-on by default.
	EnableSso interface{} `json:"enableSso" yaml:"enableSso"`
	// The NetBIOS name of the directory, such as `CORP` .
	ShortName *string `json:"shortName" yaml:"shortName"`
}

Properties for defining a `CfnSimpleAD`.

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import directoryservice "github.com/aws/aws-cdk-go/awscdk/aws_directoryservice"
cfnSimpleADProps := &cfnSimpleADProps{
	name: jsii.String("name"),
	password: jsii.String("password"),
	size: jsii.String("size"),
	vpcSettings: &vpcSettingsProperty{
		subnetIds: []*string{
			jsii.String("subnetIds"),
		},
		vpcId: jsii.String("vpcId"),
	},

	// the properties below are optional
	createAlias: jsii.Boolean(false),
	description: jsii.String("description"),
	enableSso: jsii.Boolean(false),
	shortName: jsii.String("shortName"),
}

type CfnSimpleAD_VpcSettingsProperty

type CfnSimpleAD_VpcSettingsProperty struct {
	// The identifiers of the subnets for the directory servers.
	//
	// The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
	SubnetIds *[]*string `json:"subnetIds" yaml:"subnetIds"`
	// The identifier of the VPC in which to create the directory.
	VpcId *string `json:"vpcId" yaml:"vpcId"`
}

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.

Example:

import awscdk "github.com/aws/aws-cdk-go/awscdk"import directoryservice "github.com/aws/aws-cdk-go/awscdk/aws_directoryservice"
vpcSettingsProperty := &vpcSettingsProperty{
	subnetIds: []*string{
		jsii.String("subnetIds"),
	},
	vpcId: jsii.String("vpcId"),
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL