Documentation
¶
Index ¶
- func AzurestackProvider_IsConstruct(x interface{}) *bool
- func AzurestackProvider_TfResourceType() *string
- func NewAzurestackProvider_Override(a AzurestackProvider, scope constructs.Construct, id *string, ...)
- type AzurestackProvider
- type AzurestackProviderConfig
- type AzurestackProviderFeatures
- type AzurestackProviderFeaturesResourceGroup
- type AzurestackProviderFeaturesVirtualMachine
- type AzurestackProviderFeaturesVirtualMachineScaleSet
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AzurestackProvider_IsConstruct ¶
func AzurestackProvider_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 AzurestackProvider_TfResourceType ¶
func AzurestackProvider_TfResourceType() *string
func NewAzurestackProvider_Override ¶
func NewAzurestackProvider_Override(a AzurestackProvider, scope constructs.Construct, id *string, config *AzurestackProviderConfig)
Create a new {@link https://www.terraform.io/docs/providers/azurestack azurestack} Resource.
Types ¶
type AzurestackProvider ¶
type AzurestackProvider interface {
cdktf.TerraformProvider
Alias() *string
SetAlias(val *string)
AliasInput() *string
ArmEndpoint() *string
SetArmEndpoint(val *string)
ArmEndpointInput() *string
AuxiliaryTenantIds() *[]*string
SetAuxiliaryTenantIds(val *[]*string)
AuxiliaryTenantIdsInput() *[]*string
// Experimental.
CdktfStack() cdktf.TerraformStack
ClientCertificatePassword() *string
SetClientCertificatePassword(val *string)
ClientCertificatePasswordInput() *string
ClientCertificatePath() *string
SetClientCertificatePath(val *string)
ClientCertificatePathInput() *string
ClientId() *string
SetClientId(val *string)
ClientIdInput() *string
ClientSecret() *string
SetClientSecret(val *string)
ClientSecretInput() *string
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
DisableCorrelationRequestId() interface{}
SetDisableCorrelationRequestId(val interface{})
DisableCorrelationRequestIdInput() interface{}
Environment() *string
SetEnvironment(val *string)
EnvironmentInput() *string
Features() *AzurestackProviderFeatures
SetFeatures(val *AzurestackProviderFeatures)
FeaturesInput() *AzurestackProviderFeatures
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
// Experimental.
MetaAttributes() *map[string]interface{}
MetadataHost() *string
SetMetadataHost(val *string)
MetadataHostInput() *string
MsiEndpoint() *string
SetMsiEndpoint(val *string)
MsiEndpointInput() *string
// The tree node.
Node() constructs.Node
// Experimental.
RawOverrides() interface{}
SkipProviderRegistration() interface{}
SetSkipProviderRegistration(val interface{})
SkipProviderRegistrationInput() interface{}
SubscriptionId() *string
SetSubscriptionId(val *string)
SubscriptionIdInput() *string
TenantId() *string
SetTenantId(val *string)
TenantIdInput() *string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformProviderSource() *string
// Experimental.
TerraformResourceType() *string
UseMsi() interface{}
SetUseMsi(val interface{})
UseMsiInput() interface{}
// Experimental.
AddOverride(path *string, value interface{})
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
ResetAlias()
ResetArmEndpoint()
ResetAuxiliaryTenantIds()
ResetClientCertificatePassword()
ResetClientCertificatePath()
ResetClientId()
ResetClientSecret()
ResetDisableCorrelationRequestId()
ResetEnvironment()
ResetMetadataHost()
ResetMsiEndpoint()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetSkipProviderRegistration()
ResetSubscriptionId()
ResetTenantId()
ResetUseMsi()
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://www.terraform.io/docs/providers/azurestack azurestack}.
func NewAzurestackProvider ¶
func NewAzurestackProvider(scope constructs.Construct, id *string, config *AzurestackProviderConfig) AzurestackProvider
Create a new {@link https://www.terraform.io/docs/providers/azurestack azurestack} Resource.
type AzurestackProviderConfig ¶
type AzurestackProviderConfig struct {
// features block.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#features AzurestackProvider#features}
Features *AzurestackProviderFeatures `field:"required" json:"features" yaml:"features"`
// Alias name.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#alias AzurestackProvider#alias}
Alias *string `field:"optional" json:"alias" yaml:"alias"`
// The Hostname which should be used for the Azure Metadata Service.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#arm_endpoint AzurestackProvider#arm_endpoint}
ArmEndpoint *string `field:"optional" json:"armEndpoint" yaml:"armEndpoint"`
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#auxiliary_tenant_ids AzurestackProvider#auxiliary_tenant_ids}.
AuxiliaryTenantIds *[]*string `field:"optional" json:"auxiliaryTenantIds" yaml:"auxiliaryTenantIds"`
// The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#client_certificate_password AzurestackProvider#client_certificate_password}
ClientCertificatePassword *string `field:"optional" json:"clientCertificatePassword" yaml:"clientCertificatePassword"`
// The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#client_certificate_path AzurestackProvider#client_certificate_path}
ClientCertificatePath *string `field:"optional" json:"clientCertificatePath" yaml:"clientCertificatePath"`
// The Client ID which should be used.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#client_id AzurestackProvider#client_id}
ClientId *string `field:"optional" json:"clientId" yaml:"clientId"`
// The Client Secret which should be used. For use When authenticating as a Service Principal using a Client Secret.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#client_secret AzurestackProvider#client_secret}
ClientSecret *string `field:"optional" json:"clientSecret" yaml:"clientSecret"`
// This will disable the x-ms-correlation-request-id header.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#disable_correlation_request_id AzurestackProvider#disable_correlation_request_id}
DisableCorrelationRequestId interface{} `field:"optional" json:"disableCorrelationRequestId" yaml:"disableCorrelationRequestId"`
// The Cloud Environment which should be used.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#environment AzurestackProvider#environment}
Environment *string `field:"optional" json:"environment" yaml:"environment"`
// The Hostname which should be used for the Azure Metadata Service.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#metadata_host AzurestackProvider#metadata_host}
MetadataHost *string `field:"optional" json:"metadataHost" yaml:"metadataHost"`
// The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#msi_endpoint AzurestackProvider#msi_endpoint}
MsiEndpoint *string `field:"optional" json:"msiEndpoint" yaml:"msiEndpoint"`
// Should the AzureStack Provider skip registering all of the Resource Providers that it supports, if they're not already registered?
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#skip_provider_registration AzurestackProvider#skip_provider_registration}
SkipProviderRegistration interface{} `field:"optional" json:"skipProviderRegistration" yaml:"skipProviderRegistration"`
// The Subscription ID which should be used.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#subscription_id AzurestackProvider#subscription_id}
SubscriptionId *string `field:"optional" json:"subscriptionId" yaml:"subscriptionId"`
// The Tenant ID which should be used.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#tenant_id AzurestackProvider#tenant_id}
TenantId *string `field:"optional" json:"tenantId" yaml:"tenantId"`
// Allowed Managed Service Identity be used for Authentication.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#use_msi AzurestackProvider#use_msi}
UseMsi interface{} `field:"optional" json:"useMsi" yaml:"useMsi"`
}
type AzurestackProviderFeatures ¶
type AzurestackProviderFeatures struct {
// resource_group block.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#resource_group AzurestackProvider#resource_group}
ResourceGroup *AzurestackProviderFeaturesResourceGroup `field:"optional" json:"resourceGroup" yaml:"resourceGroup"`
// virtual_machine block.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#virtual_machine AzurestackProvider#virtual_machine}
VirtualMachine *AzurestackProviderFeaturesVirtualMachine `field:"optional" json:"virtualMachine" yaml:"virtualMachine"`
// virtual_machine_scale_set block.
//
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#virtual_machine_scale_set AzurestackProvider#virtual_machine_scale_set}
VirtualMachineScaleSet *AzurestackProviderFeaturesVirtualMachineScaleSet `field:"optional" json:"virtualMachineScaleSet" yaml:"virtualMachineScaleSet"`
}
type AzurestackProviderFeaturesResourceGroup ¶
type AzurestackProviderFeaturesResourceGroup struct {
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#prevent_deletion_if_contains_resources AzurestackProvider#prevent_deletion_if_contains_resources}.
PreventDeletionIfContainsResources interface{} `field:"optional" json:"preventDeletionIfContainsResources" yaml:"preventDeletionIfContainsResources"`
}
type AzurestackProviderFeaturesVirtualMachine ¶
type AzurestackProviderFeaturesVirtualMachine struct {
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#delete_os_disk_on_deletion AzurestackProvider#delete_os_disk_on_deletion}.
DeleteOsDiskOnDeletion interface{} `field:"optional" json:"deleteOsDiskOnDeletion" yaml:"deleteOsDiskOnDeletion"`
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#graceful_shutdown AzurestackProvider#graceful_shutdown}.
GracefulShutdown interface{} `field:"optional" json:"gracefulShutdown" yaml:"gracefulShutdown"`
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#skip_shutdown_and_force_delete AzurestackProvider#skip_shutdown_and_force_delete}.
SkipShutdownAndForceDelete interface{} `field:"optional" json:"skipShutdownAndForceDelete" yaml:"skipShutdownAndForceDelete"`
}
type AzurestackProviderFeaturesVirtualMachineScaleSet ¶
type AzurestackProviderFeaturesVirtualMachineScaleSet struct {
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#roll_instances_when_required AzurestackProvider#roll_instances_when_required}.
RollInstancesWhenRequired interface{} `field:"required" json:"rollInstancesWhenRequired" yaml:"rollInstancesWhenRequired"`
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#force_delete AzurestackProvider#force_delete}.
ForceDelete interface{} `field:"optional" json:"forceDelete" yaml:"forceDelete"`
// Docs at Terraform Registry: {@link https://www.terraform.io/docs/providers/azurestack#scale_to_zero_before_deletion AzurestackProvider#scale_to_zero_before_deletion}.
ScaleToZeroBeforeDeletion interface{} `field:"optional" json:"scaleToZeroBeforeDeletion" yaml:"scaleToZeroBeforeDeletion"`
}
Source Files
¶
- provider.go
- provider_AzurestackProvider.go
- provider_AzurestackProviderConfig.go
- provider_AzurestackProviderFeatures.go
- provider_AzurestackProviderFeaturesResourceGroup.go
- provider_AzurestackProviderFeaturesVirtualMachine.go
- provider_AzurestackProviderFeaturesVirtualMachineScaleSet.go
- provider_AzurestackProvider__runtime_type_checks.go