Documentation
¶
Index ¶
- func CfnMicrosoftAD_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMicrosoftAD_IsCfnElement(x interface{}) *bool
- func CfnMicrosoftAD_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnMicrosoftAD_IsConstruct(x interface{}) *bool
- func CfnSimpleAD_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSimpleAD_IsCfnElement(x interface{}) *bool
- func CfnSimpleAD_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSimpleAD_IsConstruct(x interface{}) *bool
- func NewCfnMicrosoftAD_Override(c CfnMicrosoftAD, scope awscdk.Construct, id *string, ...)
- func NewCfnSimpleAD_Override(c CfnSimpleAD, scope awscdk.Construct, id *string, props *CfnSimpleADProps)
- type CfnMicrosoftAD
- type CfnMicrosoftADProps
- type CfnMicrosoftAD_VpcSettingsProperty
- type CfnSimpleAD
- type CfnSimpleADProps
- type CfnSimpleAD_VpcSettingsProperty
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. Experimental.
func CfnMicrosoftAD_IsCfnResource ¶
func CfnMicrosoftAD_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnMicrosoftAD_IsConstruct ¶
func CfnMicrosoftAD_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
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. Experimental.
func CfnSimpleAD_IsCfnResource ¶
func CfnSimpleAD_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSimpleAD_IsConstruct ¶
func CfnSimpleAD_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnMicrosoftAD_Override ¶
func NewCfnMicrosoftAD_Override(c CfnMicrosoftAD, scope awscdk.Construct, id *string, props *CfnMicrosoftADProps)
Create a new `AWS::DirectoryService::MicrosoftAD`.
func NewCfnSimpleAD_Override ¶
func NewCfnSimpleAD_Override(c CfnSimpleAD, scope awscdk.Construct, id *string, props *CfnSimpleADProps)
Create a new `AWS::DirectoryService::SimpleAD`.
Types ¶
type CfnMicrosoftAD ¶
type CfnMicrosoftAD interface {
awscdk.CfnResource
awscdk.IInspectable
AttrAlias() *string
AttrDnsIpAddresses() *[]*string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreateAlias() interface{}
SetCreateAlias(val interface{})
CreationStack() *[]*string
Edition() *string
SetEdition(val *string)
EnableSso() interface{}
SetEnableSso(val interface{})
LogicalId() *string
Name() *string
SetName(val *string)
Node() awscdk.ConstructNode
Password() *string
SetPassword(val *string)
Ref() *string
ShortName() *string
SetShortName(val *string)
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
VpcSettings() interface{}
SetVpcSettings(val interface{})
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*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* .
TODO: EXAMPLE
func NewCfnMicrosoftAD ¶
func NewCfnMicrosoftAD(scope awscdk.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`.
TODO: EXAMPLE
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.
TODO: EXAMPLE
type CfnSimpleAD ¶
type CfnSimpleAD interface {
awscdk.CfnResource
awscdk.IInspectable
AttrAlias() *string
AttrDnsIpAddresses() *[]*string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreateAlias() interface{}
SetCreateAlias(val interface{})
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
EnableSso() interface{}
SetEnableSso(val interface{})
LogicalId() *string
Name() *string
SetName(val *string)
Node() awscdk.ConstructNode
Password() *string
SetPassword(val *string)
Ref() *string
ShortName() *string
SetShortName(val *string)
Size() *string
SetSize(val *string)
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
VpcSettings() interface{}
SetVpcSettings(val interface{})
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*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* .
TODO: EXAMPLE
func NewCfnSimpleAD ¶
func NewCfnSimpleAD(scope awscdk.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`.
TODO: EXAMPLE
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.
TODO: EXAMPLE