Documentation ¶
Index ¶
- func Group_IsConstruct(x interface{}) *bool
- func Group_IsTerraformElement(x interface{}) *bool
- func Group_IsTerraformResource(x interface{}) *bool
- func Group_TfResourceType() *string
- func NewGroupDynamicMembershipOutputReference_Override(g GroupDynamicMembershipOutputReference, ...)
- func NewGroupTimeoutsOutputReference_Override(g GroupTimeoutsOutputReference, terraformResource cdktf.IInterpolatingParent, ...)
- func NewGroup_Override(g Group, scope constructs.Construct, id *string, config *GroupConfig)
- type Group
- type GroupConfig
- type GroupDynamicMembership
- type GroupDynamicMembershipOutputReference
- type GroupTimeouts
- type GroupTimeoutsOutputReference
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Group_IsConstruct ¶
func Group_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func Group_TfResourceType ¶
func Group_TfResourceType() *string
func NewGroupDynamicMembershipOutputReference_Override ¶
func NewGroupDynamicMembershipOutputReference_Override(g GroupDynamicMembershipOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewGroupTimeoutsOutputReference_Override ¶
func NewGroupTimeoutsOutputReference_Override(g GroupTimeoutsOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewGroup_Override ¶
func NewGroup_Override(g Group, scope constructs.Construct, id *string, config *GroupConfig)
Create a new {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group azuread_group} Resource.
Types ¶
type Group ¶
type Group interface { cdktf.TerraformResource AdministrativeUnitIds() *[]*string SetAdministrativeUnitIds(val *[]*string) AdministrativeUnitIdsInput() *[]*string AssignableToRole() interface{} SetAssignableToRole(val interface{}) AssignableToRoleInput() interface{} AutoSubscribeNewMembers() interface{} SetAutoSubscribeNewMembers(val interface{}) AutoSubscribeNewMembersInput() interface{} Behaviors() *[]*string SetBehaviors(val *[]*string) BehaviorsInput() *[]*string // Experimental. CdktfStack() cdktf.TerraformStack // Experimental. Connection() interface{} // Experimental. SetConnection(val interface{}) // Experimental. ConstructNodeMetadata() *map[string]interface{} // Experimental. Count() interface{} // Experimental. SetCount(val interface{}) // Experimental. DependsOn() *[]*string // Experimental. SetDependsOn(val *[]*string) Description() *string SetDescription(val *string) DescriptionInput() *string DisplayName() *string SetDisplayName(val *string) DisplayNameInput() *string DynamicMembership() GroupDynamicMembershipOutputReference DynamicMembershipInput() *GroupDynamicMembership ExternalSendersAllowed() interface{} SetExternalSendersAllowed(val interface{}) ExternalSendersAllowedInput() interface{} // Experimental. ForEach() cdktf.ITerraformIterator // Experimental. SetForEach(val cdktf.ITerraformIterator) // Experimental. Fqn() *string // Experimental. FriendlyUniqueId() *string HideFromAddressLists() interface{} SetHideFromAddressLists(val interface{}) HideFromAddressListsInput() interface{} HideFromOutlookClients() interface{} SetHideFromOutlookClients(val interface{}) HideFromOutlookClientsInput() interface{} Id() *string SetId(val *string) IdInput() *string // Experimental. Lifecycle() *cdktf.TerraformResourceLifecycle // Experimental. SetLifecycle(val *cdktf.TerraformResourceLifecycle) Mail() *string MailEnabled() interface{} SetMailEnabled(val interface{}) MailEnabledInput() interface{} MailNickname() *string SetMailNickname(val *string) MailNicknameInput() *string Members() *[]*string SetMembers(val *[]*string) MembersInput() *[]*string // The tree node. Node() constructs.Node ObjectId() *string OnpremisesDomainName() *string OnpremisesGroupType() *string SetOnpremisesGroupType(val *string) OnpremisesGroupTypeInput() *string OnpremisesNetbiosName() *string OnpremisesSamAccountName() *string OnpremisesSecurityIdentifier() *string OnpremisesSyncEnabled() cdktf.IResolvable Owners() *[]*string SetOwners(val *[]*string) OwnersInput() *[]*string PreferredLanguage() *string PreventDuplicateNames() interface{} SetPreventDuplicateNames(val interface{}) PreventDuplicateNamesInput() interface{} // Experimental. Provider() cdktf.TerraformProvider // Experimental. SetProvider(val cdktf.TerraformProvider) // Experimental. Provisioners() *[]interface{} // Experimental. SetProvisioners(val *[]interface{}) ProvisioningOptions() *[]*string SetProvisioningOptions(val *[]*string) ProvisioningOptionsInput() *[]*string ProxyAddresses() *[]*string // Experimental. RawOverrides() interface{} SecurityEnabled() interface{} SetSecurityEnabled(val interface{}) SecurityEnabledInput() interface{} // Experimental. TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata // Experimental. TerraformMetaArguments() *map[string]interface{} // Experimental. TerraformResourceType() *string Theme() *string SetTheme(val *string) ThemeInput() *string Timeouts() GroupTimeoutsOutputReference TimeoutsInput() interface{} Types() *[]*string SetTypes(val *[]*string) TypesInput() *[]*string Visibility() *string SetVisibility(val *string) VisibilityInput() *string WritebackEnabled() interface{} SetWritebackEnabled(val interface{}) WritebackEnabledInput() interface{} // Experimental. AddOverride(path *string, value interface{}) // Experimental. GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{} // Experimental. GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable // Experimental. GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool // Experimental. GetListAttribute(terraformAttribute *string) *[]*string // Experimental. GetNumberAttribute(terraformAttribute *string) *float64 // Experimental. GetNumberListAttribute(terraformAttribute *string) *[]*float64 // Experimental. GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64 // Experimental. GetStringAttribute(terraformAttribute *string) *string // Experimental. GetStringMapAttribute(terraformAttribute *string) *map[string]*string // Experimental. InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) PutDynamicMembership(value *GroupDynamicMembership) PutTimeouts(value *GroupTimeouts) ResetAdministrativeUnitIds() ResetAssignableToRole() ResetAutoSubscribeNewMembers() ResetBehaviors() ResetDescription() ResetDynamicMembership() ResetExternalSendersAllowed() ResetHideFromAddressLists() ResetHideFromOutlookClients() ResetId() ResetMailEnabled() ResetMailNickname() ResetMembers() ResetOnpremisesGroupType() // Resets a previously passed logical Id to use the auto-generated logical id again. // Experimental. ResetOverrideLogicalId() ResetOwners() ResetPreventDuplicateNames() ResetProvisioningOptions() ResetSecurityEnabled() ResetTheme() ResetTimeouts() ResetTypes() ResetVisibility() ResetWritebackEnabled() SynthesizeAttributes() *map[string]interface{} // Experimental. ToMetadata() interface{} // Returns a string representation of this construct. ToString() *string // Adds this resource to the terraform JSON output. // Experimental. ToTerraform() interface{} }
Represents a {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group azuread_group}.
func NewGroup ¶
func NewGroup(scope constructs.Construct, id *string, config *GroupConfig) Group
Create a new {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group azuread_group} Resource.
type GroupConfig ¶
type GroupConfig struct { // Experimental. Connection interface{} `field:"optional" json:"connection" yaml:"connection"` // Experimental. Count interface{} `field:"optional" json:"count" yaml:"count"` // Experimental. DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"` // Experimental. ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"` // Experimental. Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"` // Experimental. Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"` // Experimental. Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"` // The display name for the group. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#display_name Group#display_name} DisplayName *string `field:"required" json:"displayName" yaml:"displayName"` // The administrative unit IDs in which the group should be. // // If empty, the group will be created at the tenant level. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#administrative_unit_ids Group#administrative_unit_ids} AdministrativeUnitIds *[]*string `field:"optional" json:"administrativeUnitIds" yaml:"administrativeUnitIds"` // Indicates whether this group can be assigned to an Azure Active Directory role. // // This property can only be `true` for security-enabled groups. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#assignable_to_role Group#assignable_to_role} AssignableToRole interface{} `field:"optional" json:"assignableToRole" yaml:"assignableToRole"` // Indicates whether new members added to the group will be auto-subscribed to receive email notifications. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#auto_subscribe_new_members Group#auto_subscribe_new_members} AutoSubscribeNewMembers interface{} `field:"optional" json:"autoSubscribeNewMembers" yaml:"autoSubscribeNewMembers"` // The group behaviours for a Microsoft 365 group. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#behaviors Group#behaviors} Behaviors *[]*string `field:"optional" json:"behaviors" yaml:"behaviors"` // The description for the group. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#description Group#description} Description *string `field:"optional" json:"description" yaml:"description"` // dynamic_membership block. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#dynamic_membership Group#dynamic_membership} DynamicMembership *GroupDynamicMembership `field:"optional" json:"dynamicMembership" yaml:"dynamicMembership"` // Indicates whether people external to the organization can send messages to the group. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#external_senders_allowed Group#external_senders_allowed} ExternalSendersAllowed interface{} `field:"optional" json:"externalSendersAllowed" yaml:"externalSendersAllowed"` // Indicates whether the group is displayed in certain parts of the Outlook user interface: in the Address Book, in address lists for selecting message recipients, and in the Browse Groups dialog for searching groups. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#hide_from_address_lists Group#hide_from_address_lists} HideFromAddressLists interface{} `field:"optional" json:"hideFromAddressLists" yaml:"hideFromAddressLists"` // Indicates whether the group is displayed in Outlook clients, such as Outlook for Windows and Outlook on the web. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#hide_from_outlook_clients Group#hide_from_outlook_clients} HideFromOutlookClients interface{} `field:"optional" json:"hideFromOutlookClients" yaml:"hideFromOutlookClients"` // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#id Group#id}. // // Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. // If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable. Id *string `field:"optional" json:"id" yaml:"id"` // Whether the group is a mail enabled, with a shared group mailbox. // // At least one of `mail_enabled` or `security_enabled` must be specified. A group can be mail enabled _and_ security enabled // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#mail_enabled Group#mail_enabled} MailEnabled interface{} `field:"optional" json:"mailEnabled" yaml:"mailEnabled"` // The mail alias for the group, unique in the organisation. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#mail_nickname Group#mail_nickname} MailNickname *string `field:"optional" json:"mailNickname" yaml:"mailNickname"` // A set of members who should be present in this group. // // Supported object types are Users, Groups or Service Principals // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#members Group#members} Members *[]*string `field:"optional" json:"members" yaml:"members"` // Indicates the target on-premise group type the group will be written back as. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#onpremises_group_type Group#onpremises_group_type} OnpremisesGroupType *string `field:"optional" json:"onpremisesGroupType" yaml:"onpremisesGroupType"` // A set of owners who own this group. Supported object types are Users or Service Principals. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#owners Group#owners} Owners *[]*string `field:"optional" json:"owners" yaml:"owners"` // If `true`, will return an error if an existing group is found with the same name. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#prevent_duplicate_names Group#prevent_duplicate_names} PreventDuplicateNames interface{} `field:"optional" json:"preventDuplicateNames" yaml:"preventDuplicateNames"` // The group provisioning options for a Microsoft 365 group. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#provisioning_options Group#provisioning_options} ProvisioningOptions *[]*string `field:"optional" json:"provisioningOptions" yaml:"provisioningOptions"` // Whether the group is a security group for controlling access to in-app resources. // // At least one of `security_enabled` or `mail_enabled` must be specified. A group can be security enabled _and_ mail enabled // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#security_enabled Group#security_enabled} SecurityEnabled interface{} `field:"optional" json:"securityEnabled" yaml:"securityEnabled"` // The colour theme for a Microsoft 365 group. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#theme Group#theme} Theme *string `field:"optional" json:"theme" yaml:"theme"` // timeouts block. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#timeouts Group#timeouts} Timeouts *GroupTimeouts `field:"optional" json:"timeouts" yaml:"timeouts"` // A set of group types to configure for the group. // // `Unified` specifies a Microsoft 365 group. Required when `mail_enabled` is true // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#types Group#types} Types *[]*string `field:"optional" json:"types" yaml:"types"` // Specifies the group join policy and group content visibility. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#visibility Group#visibility} Visibility *string `field:"optional" json:"visibility" yaml:"visibility"` // Whether this group should be synced from Azure AD to the on-premises directory when Azure AD Connect is used. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#writeback_enabled Group#writeback_enabled} WritebackEnabled interface{} `field:"optional" json:"writebackEnabled" yaml:"writebackEnabled"` }
type GroupDynamicMembership ¶
type GroupDynamicMembership struct { // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#enabled Group#enabled}. Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"` // Rule to determine members for a dynamic group. Required when `group_types` contains 'DynamicMembership'. // // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#rule Group#rule} Rule *string `field:"required" json:"rule" yaml:"rule"` }
type GroupDynamicMembershipOutputReference ¶
type GroupDynamicMembershipOutputReference interface { cdktf.ComplexObject // the index of the complex object in a list. // Experimental. ComplexObjectIndex() interface{} // Experimental. SetComplexObjectIndex(val interface{}) // set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items. // Experimental. ComplexObjectIsFromSet() *bool // Experimental. SetComplexObjectIsFromSet(val *bool) // The creation stack of this resolvable which will be appended to errors thrown during resolution. // // If this returns an empty array the stack will not be attached. // Experimental. CreationStack() *[]*string Enabled() interface{} SetEnabled(val interface{}) EnabledInput() interface{} // Experimental. Fqn() *string InternalValue() *GroupDynamicMembership SetInternalValue(val *GroupDynamicMembership) Rule() *string SetRule(val *string) RuleInput() *string // Experimental. TerraformAttribute() *string // Experimental. SetTerraformAttribute(val *string) // Experimental. TerraformResource() cdktf.IInterpolatingParent // Experimental. SetTerraformResource(val cdktf.IInterpolatingParent) // Experimental. ComputeFqn() *string // Experimental. GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{} // Experimental. GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable // Experimental. GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool // Experimental. GetListAttribute(terraformAttribute *string) *[]*string // Experimental. GetNumberAttribute(terraformAttribute *string) *float64 // Experimental. GetNumberListAttribute(terraformAttribute *string) *[]*float64 // Experimental. GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64 // Experimental. GetStringAttribute(terraformAttribute *string) *string // Experimental. GetStringMapAttribute(terraformAttribute *string) *map[string]*string // Experimental. InterpolationAsList() cdktf.IResolvable // Experimental. InterpolationForAttribute(property *string) cdktf.IResolvable // Produce the Token's value at resolution time. // Experimental. Resolve(_context cdktf.IResolveContext) interface{} // Return a string representation of this resolvable object. // // Returns a reversible string representation. // Experimental. ToString() *string }
func NewGroupDynamicMembershipOutputReference ¶
func NewGroupDynamicMembershipOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) GroupDynamicMembershipOutputReference
type GroupTimeouts ¶
type GroupTimeouts struct { // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#create Group#create}. Create *string `field:"optional" json:"create" yaml:"create"` // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#delete Group#delete}. Delete *string `field:"optional" json:"delete" yaml:"delete"` // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#read Group#read}. Read *string `field:"optional" json:"read" yaml:"read"` // Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/azuread/2.39.0/docs/resources/group#update Group#update}. Update *string `field:"optional" json:"update" yaml:"update"` }
type GroupTimeoutsOutputReference ¶
type GroupTimeoutsOutputReference interface { cdktf.ComplexObject // the index of the complex object in a list. // Experimental. ComplexObjectIndex() interface{} // Experimental. SetComplexObjectIndex(val interface{}) // set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items. // Experimental. ComplexObjectIsFromSet() *bool // Experimental. SetComplexObjectIsFromSet(val *bool) Create() *string SetCreate(val *string) CreateInput() *string // The creation stack of this resolvable which will be appended to errors thrown during resolution. // // If this returns an empty array the stack will not be attached. // Experimental. CreationStack() *[]*string Delete() *string SetDelete(val *string) DeleteInput() *string // Experimental. Fqn() *string InternalValue() interface{} SetInternalValue(val interface{}) Read() *string SetRead(val *string) ReadInput() *string // Experimental. TerraformAttribute() *string // Experimental. SetTerraformAttribute(val *string) // Experimental. TerraformResource() cdktf.IInterpolatingParent // Experimental. SetTerraformResource(val cdktf.IInterpolatingParent) Update() *string SetUpdate(val *string) UpdateInput() *string // Experimental. ComputeFqn() *string // Experimental. GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{} // Experimental. GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable // Experimental. GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool // Experimental. GetListAttribute(terraformAttribute *string) *[]*string // Experimental. GetNumberAttribute(terraformAttribute *string) *float64 // Experimental. GetNumberListAttribute(terraformAttribute *string) *[]*float64 // Experimental. GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64 // Experimental. GetStringAttribute(terraformAttribute *string) *string // Experimental. GetStringMapAttribute(terraformAttribute *string) *map[string]*string // Experimental. InterpolationAsList() cdktf.IResolvable // Experimental. InterpolationForAttribute(property *string) cdktf.IResolvable ResetCreate() ResetDelete() ResetRead() ResetUpdate() // Produce the Token's value at resolution time. // Experimental. Resolve(_context cdktf.IResolveContext) interface{} // Return a string representation of this resolvable object. // // Returns a reversible string representation. // Experimental. ToString() *string }
func NewGroupTimeoutsOutputReference ¶
func NewGroupTimeoutsOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) GroupTimeoutsOutputReference