Documentation
¶
Index ¶
- func CfnConnection_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConnection_IsCfnElement(x interface{}) *bool
- func CfnConnection_IsCfnResource(x interface{}) *bool
- func CfnConnection_IsConstruct(x interface{}) *bool
- func CfnDataSource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataSource_IsCfnElement(x interface{}) *bool
- func CfnDataSource_IsCfnResource(x interface{}) *bool
- func CfnDataSource_IsConstruct(x interface{}) *bool
- func CfnDomainUnit_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomainUnit_IsCfnElement(x interface{}) *bool
- func CfnDomainUnit_IsCfnResource(x interface{}) *bool
- func CfnDomainUnit_IsConstruct(x interface{}) *bool
- func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomain_FromDomainArn(scope constructs.Construct, id *string, arn *string) interfacesawsdatazone.IDomainRef
- func CfnDomain_FromDomainId(scope constructs.Construct, id *string, domainId *string) interfacesawsdatazone.IDomainRef
- func CfnDomain_IsCfnElement(x interface{}) *bool
- func CfnDomain_IsCfnResource(x interface{}) *bool
- func CfnDomain_IsConstruct(x interface{}) *bool
- func CfnEnvironmentActions_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironmentActions_IsCfnElement(x interface{}) *bool
- func CfnEnvironmentActions_IsCfnResource(x interface{}) *bool
- func CfnEnvironmentActions_IsConstruct(x interface{}) *bool
- func CfnEnvironmentBlueprintConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironmentBlueprintConfiguration_IsCfnElement(x interface{}) *bool
- func CfnEnvironmentBlueprintConfiguration_IsCfnResource(x interface{}) *bool
- func CfnEnvironmentBlueprintConfiguration_IsConstruct(x interface{}) *bool
- func CfnEnvironmentProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironmentProfile_IsCfnElement(x interface{}) *bool
- func CfnEnvironmentProfile_IsCfnResource(x interface{}) *bool
- func CfnEnvironmentProfile_IsConstruct(x interface{}) *bool
- func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironment_IsCfnElement(x interface{}) *bool
- func CfnEnvironment_IsCfnResource(x interface{}) *bool
- func CfnEnvironment_IsConstruct(x interface{}) *bool
- func CfnFormType_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFormType_IsCfnElement(x interface{}) *bool
- func CfnFormType_IsCfnResource(x interface{}) *bool
- func CfnFormType_IsConstruct(x interface{}) *bool
- func CfnGroupProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGroupProfile_IsCfnElement(x interface{}) *bool
- func CfnGroupProfile_IsCfnResource(x interface{}) *bool
- func CfnGroupProfile_IsConstruct(x interface{}) *bool
- func CfnOwner_CFN_RESOURCE_TYPE_NAME() *string
- func CfnOwner_IsCfnElement(x interface{}) *bool
- func CfnOwner_IsCfnResource(x interface{}) *bool
- func CfnOwner_IsConstruct(x interface{}) *bool
- func CfnPolicyGrant_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPolicyGrant_IsCfnElement(x interface{}) *bool
- func CfnPolicyGrant_IsCfnResource(x interface{}) *bool
- func CfnPolicyGrant_IsConstruct(x interface{}) *bool
- func CfnProjectMembership_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProjectMembership_IsCfnElement(x interface{}) *bool
- func CfnProjectMembership_IsCfnResource(x interface{}) *bool
- func CfnProjectMembership_IsConstruct(x interface{}) *bool
- func CfnProjectProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProjectProfile_IsCfnElement(x interface{}) *bool
- func CfnProjectProfile_IsCfnResource(x interface{}) *bool
- func CfnProjectProfile_IsConstruct(x interface{}) *bool
- func CfnProject_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProject_IsCfnElement(x interface{}) *bool
- func CfnProject_IsCfnResource(x interface{}) *bool
- func CfnProject_IsConstruct(x interface{}) *bool
- func CfnSubscriptionTarget_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubscriptionTarget_IsCfnElement(x interface{}) *bool
- func CfnSubscriptionTarget_IsCfnResource(x interface{}) *bool
- func CfnSubscriptionTarget_IsConstruct(x interface{}) *bool
- func CfnUserProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUserProfile_IsCfnElement(x interface{}) *bool
- func CfnUserProfile_IsCfnResource(x interface{}) *bool
- func CfnUserProfile_IsConstruct(x interface{}) *bool
- func NewCfnConnection_Override(c CfnConnection, scope constructs.Construct, id *string, ...)
- func NewCfnDataSource_Override(c CfnDataSource, scope constructs.Construct, id *string, ...)
- func NewCfnDomainUnit_Override(c CfnDomainUnit, scope constructs.Construct, id *string, ...)
- func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
- func NewCfnEnvironmentActions_Override(c CfnEnvironmentActions, scope constructs.Construct, id *string, ...)
- func NewCfnEnvironmentBlueprintConfiguration_Override(c CfnEnvironmentBlueprintConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnEnvironmentProfile_Override(c CfnEnvironmentProfile, scope constructs.Construct, id *string, ...)
- func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, ...)
- func NewCfnFormType_Override(c CfnFormType, scope constructs.Construct, id *string, props *CfnFormTypeProps)
- func NewCfnGroupProfile_Override(c CfnGroupProfile, scope constructs.Construct, id *string, ...)
- func NewCfnOwner_Override(c CfnOwner, scope constructs.Construct, id *string, props *CfnOwnerProps)
- func NewCfnPolicyGrant_Override(c CfnPolicyGrant, scope constructs.Construct, id *string, ...)
- func NewCfnProjectMembership_Override(c CfnProjectMembership, scope constructs.Construct, id *string, ...)
- func NewCfnProjectProfile_Override(c CfnProjectProfile, scope constructs.Construct, id *string, ...)
- func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
- func NewCfnSubscriptionTarget_Override(c CfnSubscriptionTarget, scope constructs.Construct, id *string, ...)
- func NewCfnUserProfile_Override(c CfnUserProfile, scope constructs.Construct, id *string, ...)
- type CfnConnection
- type CfnConnectionProps
- type CfnConnection_AmazonQPropertiesInputProperty
- type CfnConnection_AthenaPropertiesInputProperty
- type CfnConnection_AuthenticationConfigurationInputProperty
- type CfnConnection_AuthorizationCodePropertiesProperty
- type CfnConnection_AwsLocationProperty
- type CfnConnection_BasicAuthenticationCredentialsProperty
- type CfnConnection_ConnectionPropertiesInputProperty
- type CfnConnection_GlueConnectionInputProperty
- type CfnConnection_GlueOAuth2CredentialsProperty
- type CfnConnection_GluePropertiesInputProperty
- type CfnConnection_HyperPodPropertiesInputProperty
- type CfnConnection_IamPropertiesInputProperty
- type CfnConnection_LineageSyncScheduleProperty
- type CfnConnection_OAuth2ClientApplicationProperty
- type CfnConnection_OAuth2PropertiesProperty
- type CfnConnection_PhysicalConnectionRequirementsProperty
- type CfnConnection_RedshiftCredentialsProperty
- type CfnConnection_RedshiftLineageSyncConfigurationInputProperty
- type CfnConnection_RedshiftPropertiesInputProperty
- type CfnConnection_RedshiftStoragePropertiesProperty
- type CfnConnection_S3PropertiesInputProperty
- type CfnConnection_SparkEmrPropertiesInputProperty
- type CfnConnection_SparkGlueArgsProperty
- type CfnConnection_SparkGluePropertiesInputProperty
- type CfnConnection_UsernamePasswordProperty
- type CfnDataSource
- type CfnDataSourceProps
- type CfnDataSource_DataSourceConfigurationInputProperty
- type CfnDataSource_FilterExpressionProperty
- type CfnDataSource_FormInputProperty
- type CfnDataSource_GlueRunConfigurationInputProperty
- type CfnDataSource_RecommendationConfigurationProperty
- type CfnDataSource_RedshiftClusterStorageProperty
- type CfnDataSource_RedshiftCredentialConfigurationProperty
- type CfnDataSource_RedshiftRunConfigurationInputProperty
- type CfnDataSource_RedshiftServerlessStorageProperty
- type CfnDataSource_RedshiftStorageProperty
- type CfnDataSource_RelationalFilterConfigurationProperty
- type CfnDataSource_SageMakerRunConfigurationInputProperty
- type CfnDataSource_ScheduleConfigurationProperty
- type CfnDomain
- type CfnDomainProps
- type CfnDomainUnit
- type CfnDomainUnitProps
- type CfnDomain_SingleSignOnProperty
- type CfnEnvironment
- type CfnEnvironmentActions
- type CfnEnvironmentActionsProps
- type CfnEnvironmentActions_AwsConsoleLinkParametersProperty
- type CfnEnvironmentBlueprintConfiguration
- type CfnEnvironmentBlueprintConfigurationProps
- type CfnEnvironmentBlueprintConfiguration_LakeFormationConfigurationProperty
- type CfnEnvironmentBlueprintConfiguration_ProvisioningConfigurationProperty
- type CfnEnvironmentBlueprintConfiguration_RegionalParameterProperty
- type CfnEnvironmentProfile
- type CfnEnvironmentProfileProps
- type CfnEnvironmentProfile_EnvironmentParameterProperty
- type CfnEnvironmentProps
- type CfnEnvironment_EnvironmentParameterProperty
- type CfnFormType
- type CfnFormTypeProps
- type CfnFormType_ModelProperty
- type CfnGroupProfile
- type CfnGroupProfileProps
- type CfnOwner
- type CfnOwnerProps
- type CfnOwner_OwnerGroupPropertiesProperty
- type CfnOwner_OwnerPropertiesProperty
- type CfnOwner_OwnerUserPropertiesProperty
- type CfnPolicyGrant
- type CfnPolicyGrantProps
- type CfnPolicyGrant_AddToProjectMemberPoolPolicyGrantDetailProperty
- type CfnPolicyGrant_CreateAssetTypePolicyGrantDetailProperty
- type CfnPolicyGrant_CreateDomainUnitPolicyGrantDetailProperty
- type CfnPolicyGrant_CreateEnvironmentProfilePolicyGrantDetailProperty
- type CfnPolicyGrant_CreateFormTypePolicyGrantDetailProperty
- type CfnPolicyGrant_CreateGlossaryPolicyGrantDetailProperty
- type CfnPolicyGrant_CreateProjectFromProjectProfilePolicyGrantDetailProperty
- type CfnPolicyGrant_CreateProjectPolicyGrantDetailProperty
- type CfnPolicyGrant_DomainUnitFilterForProjectProperty
- type CfnPolicyGrant_DomainUnitGrantFilterProperty
- type CfnPolicyGrant_DomainUnitPolicyGrantPrincipalProperty
- type CfnPolicyGrant_GroupPolicyGrantPrincipalProperty
- type CfnPolicyGrant_OverrideDomainUnitOwnersPolicyGrantDetailProperty
- type CfnPolicyGrant_OverrideProjectOwnersPolicyGrantDetailProperty
- type CfnPolicyGrant_PolicyGrantDetailProperty
- type CfnPolicyGrant_PolicyGrantPrincipalProperty
- type CfnPolicyGrant_ProjectGrantFilterProperty
- type CfnPolicyGrant_ProjectPolicyGrantPrincipalProperty
- type CfnPolicyGrant_UserPolicyGrantPrincipalProperty
- type CfnProject
- type CfnProjectMembership
- type CfnProjectMembershipProps
- type CfnProjectMembership_MemberProperty
- type CfnProjectProfile
- type CfnProjectProfileProps
- type CfnProjectProfile_AwsAccountProperty
- type CfnProjectProfile_EnvironmentConfigurationParameterProperty
- type CfnProjectProfile_EnvironmentConfigurationParametersDetailsProperty
- type CfnProjectProfile_EnvironmentConfigurationProperty
- type CfnProjectProfile_RegionProperty
- type CfnProjectProps
- type CfnProject_EnvironmentConfigurationUserParameterProperty
- type CfnProject_EnvironmentParameterProperty
- type CfnSubscriptionTarget
- type CfnSubscriptionTargetProps
- type CfnSubscriptionTarget_SubscriptionTargetFormProperty
- type CfnUserProfile
- type CfnUserProfileProps
- type CfnUserProfile_IamUserProfileDetailsProperty
- type CfnUserProfile_SsoUserProfileDetailsProperty
- type CfnUserProfile_UserProfileDetailsProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnConnection_CFN_RESOURCE_TYPE_NAME ¶ added in v2.186.0
func CfnConnection_CFN_RESOURCE_TYPE_NAME() *string
func CfnConnection_IsCfnElement ¶ added in v2.186.0
func CfnConnection_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 CfnConnection_IsCfnResource ¶ added in v2.186.0
func CfnConnection_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnConnection_IsConstruct ¶ added in v2.186.0
func CfnConnection_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 CfnDataSource_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataSource_IsCfnElement ¶
func CfnDataSource_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 CfnDataSource_IsCfnResource ¶
func CfnDataSource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDataSource_IsConstruct ¶
func CfnDataSource_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 CfnDomainUnit_CFN_RESOURCE_TYPE_NAME ¶ added in v2.195.0
func CfnDomainUnit_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomainUnit_IsCfnElement ¶ added in v2.195.0
func CfnDomainUnit_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 CfnDomainUnit_IsCfnResource ¶ added in v2.195.0
func CfnDomainUnit_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDomainUnit_IsConstruct ¶ added in v2.195.0
func CfnDomainUnit_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 CfnDomain_CFN_RESOURCE_TYPE_NAME ¶
func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomain_FromDomainArn ¶ added in v2.218.0
func CfnDomain_FromDomainArn(scope constructs.Construct, id *string, arn *string) interfacesawsdatazone.IDomainRef
Creates a new IDomainRef from an ARN.
func CfnDomain_FromDomainId ¶ added in v2.218.0
func CfnDomain_FromDomainId(scope constructs.Construct, id *string, domainId *string) interfacesawsdatazone.IDomainRef
Creates a new IDomainRef from a domainId.
func CfnDomain_IsCfnElement ¶
func CfnDomain_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 CfnDomain_IsCfnResource ¶
func CfnDomain_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDomain_IsConstruct ¶
func CfnDomain_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 CfnEnvironmentActions_CFN_RESOURCE_TYPE_NAME ¶ added in v2.159.0
func CfnEnvironmentActions_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnvironmentActions_IsCfnElement ¶ added in v2.159.0
func CfnEnvironmentActions_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 CfnEnvironmentActions_IsCfnResource ¶ added in v2.159.0
func CfnEnvironmentActions_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEnvironmentActions_IsConstruct ¶ added in v2.159.0
func CfnEnvironmentActions_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 CfnEnvironmentBlueprintConfiguration_CFN_RESOURCE_TYPE_NAME ¶
func CfnEnvironmentBlueprintConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnvironmentBlueprintConfiguration_IsCfnElement ¶
func CfnEnvironmentBlueprintConfiguration_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 CfnEnvironmentBlueprintConfiguration_IsCfnResource ¶
func CfnEnvironmentBlueprintConfiguration_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEnvironmentBlueprintConfiguration_IsConstruct ¶
func CfnEnvironmentBlueprintConfiguration_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 CfnEnvironmentProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnEnvironmentProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnvironmentProfile_IsCfnElement ¶
func CfnEnvironmentProfile_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 CfnEnvironmentProfile_IsCfnResource ¶
func CfnEnvironmentProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEnvironmentProfile_IsConstruct ¶
func CfnEnvironmentProfile_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 CfnEnvironment_CFN_RESOURCE_TYPE_NAME ¶
func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnvironment_IsCfnElement ¶
func CfnEnvironment_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 CfnEnvironment_IsCfnResource ¶
func CfnEnvironment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEnvironment_IsConstruct ¶
func CfnEnvironment_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 CfnFormType_CFN_RESOURCE_TYPE_NAME ¶ added in v2.217.0
func CfnFormType_CFN_RESOURCE_TYPE_NAME() *string
func CfnFormType_IsCfnElement ¶ added in v2.217.0
func CfnFormType_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 CfnFormType_IsCfnResource ¶ added in v2.217.0
func CfnFormType_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFormType_IsConstruct ¶ added in v2.217.0
func CfnFormType_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 CfnGroupProfile_CFN_RESOURCE_TYPE_NAME ¶ added in v2.143.0
func CfnGroupProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnGroupProfile_IsCfnElement ¶ added in v2.143.0
func CfnGroupProfile_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 CfnGroupProfile_IsCfnResource ¶ added in v2.143.0
func CfnGroupProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGroupProfile_IsConstruct ¶ added in v2.143.0
func CfnGroupProfile_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 CfnOwner_CFN_RESOURCE_TYPE_NAME ¶ added in v2.196.0
func CfnOwner_CFN_RESOURCE_TYPE_NAME() *string
func CfnOwner_IsCfnElement ¶ added in v2.196.0
func CfnOwner_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 CfnOwner_IsCfnResource ¶ added in v2.196.0
func CfnOwner_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnOwner_IsConstruct ¶ added in v2.196.0
func CfnOwner_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 CfnPolicyGrant_CFN_RESOURCE_TYPE_NAME ¶ added in v2.214.0
func CfnPolicyGrant_CFN_RESOURCE_TYPE_NAME() *string
func CfnPolicyGrant_IsCfnElement ¶ added in v2.214.0
func CfnPolicyGrant_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 CfnPolicyGrant_IsCfnResource ¶ added in v2.214.0
func CfnPolicyGrant_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPolicyGrant_IsConstruct ¶ added in v2.214.0
func CfnPolicyGrant_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 CfnProjectMembership_CFN_RESOURCE_TYPE_NAME ¶ added in v2.143.0
func CfnProjectMembership_CFN_RESOURCE_TYPE_NAME() *string
func CfnProjectMembership_IsCfnElement ¶ added in v2.143.0
func CfnProjectMembership_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 CfnProjectMembership_IsCfnResource ¶ added in v2.143.0
func CfnProjectMembership_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnProjectMembership_IsConstruct ¶ added in v2.143.0
func CfnProjectMembership_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 CfnProjectProfile_CFN_RESOURCE_TYPE_NAME ¶ added in v2.200.0
func CfnProjectProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnProjectProfile_IsCfnElement ¶ added in v2.200.0
func CfnProjectProfile_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 CfnProjectProfile_IsCfnResource ¶ added in v2.200.0
func CfnProjectProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnProjectProfile_IsConstruct ¶ added in v2.200.0
func CfnProjectProfile_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 CfnProject_CFN_RESOURCE_TYPE_NAME ¶
func CfnProject_CFN_RESOURCE_TYPE_NAME() *string
func CfnProject_IsCfnElement ¶
func CfnProject_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 CfnProject_IsCfnResource ¶
func CfnProject_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnProject_IsConstruct ¶
func CfnProject_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 CfnSubscriptionTarget_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubscriptionTarget_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubscriptionTarget_IsCfnElement ¶
func CfnSubscriptionTarget_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 CfnSubscriptionTarget_IsCfnResource ¶
func CfnSubscriptionTarget_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSubscriptionTarget_IsConstruct ¶
func CfnSubscriptionTarget_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 CfnUserProfile_CFN_RESOURCE_TYPE_NAME ¶ added in v2.143.0
func CfnUserProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnUserProfile_IsCfnElement ¶ added in v2.143.0
func CfnUserProfile_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 CfnUserProfile_IsCfnResource ¶ added in v2.143.0
func CfnUserProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnUserProfile_IsConstruct ¶ added in v2.143.0
func CfnUserProfile_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 NewCfnConnection_Override ¶ added in v2.186.0
func NewCfnConnection_Override(c CfnConnection, scope constructs.Construct, id *string, props *CfnConnectionProps)
Create a new `AWS::DataZone::Connection`.
func NewCfnDataSource_Override ¶
func NewCfnDataSource_Override(c CfnDataSource, scope constructs.Construct, id *string, props *CfnDataSourceProps)
Create a new `AWS::DataZone::DataSource`.
func NewCfnDomainUnit_Override ¶ added in v2.195.0
func NewCfnDomainUnit_Override(c CfnDomainUnit, scope constructs.Construct, id *string, props *CfnDomainUnitProps)
Create a new `AWS::DataZone::DomainUnit`.
func NewCfnDomain_Override ¶
func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
Create a new `AWS::DataZone::Domain`.
func NewCfnEnvironmentActions_Override ¶ added in v2.159.0
func NewCfnEnvironmentActions_Override(c CfnEnvironmentActions, scope constructs.Construct, id *string, props *CfnEnvironmentActionsProps)
Create a new `AWS::DataZone::EnvironmentActions`.
func NewCfnEnvironmentBlueprintConfiguration_Override ¶
func NewCfnEnvironmentBlueprintConfiguration_Override(c CfnEnvironmentBlueprintConfiguration, scope constructs.Construct, id *string, props *CfnEnvironmentBlueprintConfigurationProps)
Create a new `AWS::DataZone::EnvironmentBlueprintConfiguration`.
func NewCfnEnvironmentProfile_Override ¶
func NewCfnEnvironmentProfile_Override(c CfnEnvironmentProfile, scope constructs.Construct, id *string, props *CfnEnvironmentProfileProps)
Create a new `AWS::DataZone::EnvironmentProfile`.
func NewCfnEnvironment_Override ¶
func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, props *CfnEnvironmentProps)
Create a new `AWS::DataZone::Environment`.
func NewCfnFormType_Override ¶ added in v2.217.0
func NewCfnFormType_Override(c CfnFormType, scope constructs.Construct, id *string, props *CfnFormTypeProps)
Create a new `AWS::DataZone::FormType`.
func NewCfnGroupProfile_Override ¶ added in v2.143.0
func NewCfnGroupProfile_Override(c CfnGroupProfile, scope constructs.Construct, id *string, props *CfnGroupProfileProps)
Create a new `AWS::DataZone::GroupProfile`.
func NewCfnOwner_Override ¶ added in v2.196.0
func NewCfnOwner_Override(c CfnOwner, scope constructs.Construct, id *string, props *CfnOwnerProps)
Create a new `AWS::DataZone::Owner`.
func NewCfnPolicyGrant_Override ¶ added in v2.214.0
func NewCfnPolicyGrant_Override(c CfnPolicyGrant, scope constructs.Construct, id *string, props *CfnPolicyGrantProps)
Create a new `AWS::DataZone::PolicyGrant`.
func NewCfnProjectMembership_Override ¶ added in v2.143.0
func NewCfnProjectMembership_Override(c CfnProjectMembership, scope constructs.Construct, id *string, props *CfnProjectMembershipProps)
Create a new `AWS::DataZone::ProjectMembership`.
func NewCfnProjectProfile_Override ¶ added in v2.200.0
func NewCfnProjectProfile_Override(c CfnProjectProfile, scope constructs.Construct, id *string, props *CfnProjectProfileProps)
Create a new `AWS::DataZone::ProjectProfile`.
func NewCfnProject_Override ¶
func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
Create a new `AWS::DataZone::Project`.
func NewCfnSubscriptionTarget_Override ¶
func NewCfnSubscriptionTarget_Override(c CfnSubscriptionTarget, scope constructs.Construct, id *string, props *CfnSubscriptionTargetProps)
Create a new `AWS::DataZone::SubscriptionTarget`.
func NewCfnUserProfile_Override ¶ added in v2.143.0
func NewCfnUserProfile_Override(c CfnUserProfile, scope constructs.Construct, id *string, props *CfnUserProfileProps)
Create a new `AWS::DataZone::UserProfile`.
Types ¶
type CfnConnection ¶ added in v2.186.0
type CfnConnection interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IConnectionRef
// The ID of the connection.
AttrConnectionId() *string
// The domain ID of the connection.
AttrDomainId() *string
// The domain unit ID of the connection.
AttrDomainUnitId() *string
// The ID of the environment.
AttrEnvironmentId() *string
// The environment user role.
AttrEnvironmentUserRole() *string
// The ID of the project.
AttrProjectId() *string
// The type of the connection.
AttrType() *string
// The location where the connection is created.
AwsLocation() interface{}
SetAwsLocation(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// A reference to a Connection resource.
ConnectionRef() *interfacesawsdatazone.ConnectionReference
// 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
// Connection description.
Description() *string
SetDescription(val *string)
// The ID of the domain where the connection is created.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
// Specifies whether the trusted identity propagation is enabled.
EnableTrustedIdentityPropagation() interface{}
SetEnableTrustedIdentityPropagation(val interface{})
Env() *interfaces.ResourceEnvironment
// The ID of the environment where the connection is created.
EnvironmentIdentifier() *string
SetEnvironmentIdentifier(val *string)
// 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 name of the connection.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The identifier of the project in which the connection should be created.
ProjectIdentifier() *string
SetProjectIdentifier(val *string)
// Connection props.
Props() interface{}
SetProps(val interface{})
// 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 scope of the connection.
Scope() *string
SetScope(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
In Amazon DataZone, a connection enables you to connect your resources (domains, projects, and environments) to external resources and services.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnConnection := awscdk.Aws_datazone.NewCfnConnection(this, jsii.String("MyCfnConnection"), &CfnConnectionProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
// the properties below are optional
AwsLocation: &AwsLocationProperty{
AccessRole: jsii.String("accessRole"),
AwsAccountId: jsii.String("awsAccountId"),
AwsRegion: jsii.String("awsRegion"),
IamConnectionId: jsii.String("iamConnectionId"),
},
Description: jsii.String("description"),
EnableTrustedIdentityPropagation: jsii.Boolean(false),
EnvironmentIdentifier: jsii.String("environmentIdentifier"),
ProjectIdentifier: jsii.String("projectIdentifier"),
Props: &ConnectionPropertiesInputProperty{
AmazonQProperties: &AmazonQPropertiesInputProperty{
AuthMode: jsii.String("authMode"),
IsEnabled: jsii.Boolean(false),
ProfileArn: jsii.String("profileArn"),
},
AthenaProperties: &AthenaPropertiesInputProperty{
WorkgroupName: jsii.String("workgroupName"),
},
GlueProperties: &GluePropertiesInputProperty{
GlueConnectionInput: &GlueConnectionInputProperty{
AthenaProperties: map[string]*string{
"athenaPropertiesKey": jsii.String("athenaProperties"),
},
AuthenticationConfiguration: &AuthenticationConfigurationInputProperty{
AuthenticationType: jsii.String("authenticationType"),
BasicAuthenticationCredentials: &BasicAuthenticationCredentialsProperty{
Password: jsii.String("password"),
UserName: jsii.String("userName"),
},
CustomAuthenticationCredentials: map[string]*string{
"customAuthenticationCredentialsKey": jsii.String("customAuthenticationCredentials"),
},
KmsKeyArn: jsii.String("kmsKeyArn"),
OAuth2Properties: &OAuth2PropertiesProperty{
AuthorizationCodeProperties: &AuthorizationCodePropertiesProperty{
AuthorizationCode: jsii.String("authorizationCode"),
RedirectUri: jsii.String("redirectUri"),
},
OAuth2ClientApplication: &OAuth2ClientApplicationProperty{
AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
},
OAuth2Credentials: &GlueOAuth2CredentialsProperty{
AccessToken: jsii.String("accessToken"),
JwtToken: jsii.String("jwtToken"),
RefreshToken: jsii.String("refreshToken"),
UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
},
OAuth2GrantType: jsii.String("oAuth2GrantType"),
TokenUrl: jsii.String("tokenUrl"),
TokenUrlParametersMap: map[string]*string{
"tokenUrlParametersMapKey": jsii.String("tokenUrlParametersMap"),
},
},
SecretArn: jsii.String("secretArn"),
},
ConnectionProperties: map[string]*string{
"connectionPropertiesKey": jsii.String("connectionProperties"),
},
ConnectionType: jsii.String("connectionType"),
Description: jsii.String("description"),
MatchCriteria: jsii.String("matchCriteria"),
Name: jsii.String("name"),
PhysicalConnectionRequirements: &PhysicalConnectionRequirementsProperty{
AvailabilityZone: jsii.String("availabilityZone"),
SecurityGroupIdList: []*string{
jsii.String("securityGroupIdList"),
},
SubnetId: jsii.String("subnetId"),
SubnetIdList: []*string{
jsii.String("subnetIdList"),
},
},
PythonProperties: map[string]*string{
"pythonPropertiesKey": jsii.String("pythonProperties"),
},
SparkProperties: map[string]*string{
"sparkPropertiesKey": jsii.String("sparkProperties"),
},
ValidateCredentials: jsii.Boolean(false),
ValidateForComputeEnvironments: []*string{
jsii.String("validateForComputeEnvironments"),
},
},
},
HyperPodProperties: &HyperPodPropertiesInputProperty{
ClusterName: jsii.String("clusterName"),
},
IamProperties: &IamPropertiesInputProperty{
GlueLineageSyncEnabled: jsii.Boolean(false),
},
RedshiftProperties: &RedshiftPropertiesInputProperty{
Credentials: &RedshiftCredentialsProperty{
SecretArn: jsii.String("secretArn"),
UsernamePassword: &UsernamePasswordProperty{
Password: jsii.String("password"),
Username: jsii.String("username"),
},
},
DatabaseName: jsii.String("databaseName"),
Host: jsii.String("host"),
LineageSync: &RedshiftLineageSyncConfigurationInputProperty{
Enabled: jsii.Boolean(false),
Schedule: &LineageSyncScheduleProperty{
Schedule: jsii.String("schedule"),
},
},
Port: jsii.Number(123),
Storage: &RedshiftStoragePropertiesProperty{
ClusterName: jsii.String("clusterName"),
WorkgroupName: jsii.String("workgroupName"),
},
},
S3Properties: &S3PropertiesInputProperty{
S3Uri: jsii.String("s3Uri"),
// the properties below are optional
S3AccessGrantLocationId: jsii.String("s3AccessGrantLocationId"),
},
SparkEmrProperties: &SparkEmrPropertiesInputProperty{
ComputeArn: jsii.String("computeArn"),
InstanceProfileArn: jsii.String("instanceProfileArn"),
JavaVirtualEnv: jsii.String("javaVirtualEnv"),
LogUri: jsii.String("logUri"),
PythonVirtualEnv: jsii.String("pythonVirtualEnv"),
RuntimeRole: jsii.String("runtimeRole"),
TrustedCertificatesS3Uri: jsii.String("trustedCertificatesS3Uri"),
},
SparkGlueProperties: &SparkGluePropertiesInputProperty{
AdditionalArgs: &SparkGlueArgsProperty{
Connection: jsii.String("connection"),
},
GlueConnectionName: jsii.String("glueConnectionName"),
GlueVersion: jsii.String("glueVersion"),
IdleTimeout: jsii.Number(123),
JavaVirtualEnv: jsii.String("javaVirtualEnv"),
NumberOfWorkers: jsii.Number(123),
PythonVirtualEnv: jsii.String("pythonVirtualEnv"),
WorkerType: jsii.String("workerType"),
},
},
Scope: jsii.String("scope"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html
func NewCfnConnection ¶ added in v2.186.0
func NewCfnConnection(scope constructs.Construct, id *string, props *CfnConnectionProps) CfnConnection
Create a new `AWS::DataZone::Connection`.
type CfnConnectionProps ¶ added in v2.186.0
type CfnConnectionProps struct {
// The ID of the domain where the connection is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The name of the connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The location where the connection is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-awslocation
//
AwsLocation interface{} `field:"optional" json:"awsLocation" yaml:"awsLocation"`
// Connection description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Specifies whether the trusted identity propagation is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-enabletrustedidentitypropagation
//
EnableTrustedIdentityPropagation interface{} `field:"optional" json:"enableTrustedIdentityPropagation" yaml:"enableTrustedIdentityPropagation"`
// The ID of the environment where the connection is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-environmentidentifier
//
EnvironmentIdentifier *string `field:"optional" json:"environmentIdentifier" yaml:"environmentIdentifier"`
// The identifier of the project in which the connection should be created.
//
// If.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-projectidentifier
//
ProjectIdentifier *string `field:"optional" json:"projectIdentifier" yaml:"projectIdentifier"`
// Connection props.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-props
//
Props interface{} `field:"optional" json:"props" yaml:"props"`
// The scope of the connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html#cfn-datazone-connection-scope
//
Scope *string `field:"optional" json:"scope" yaml:"scope"`
}
Properties for defining a `CfnConnection`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnConnectionProps := &CfnConnectionProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
// the properties below are optional
AwsLocation: &AwsLocationProperty{
AccessRole: jsii.String("accessRole"),
AwsAccountId: jsii.String("awsAccountId"),
AwsRegion: jsii.String("awsRegion"),
IamConnectionId: jsii.String("iamConnectionId"),
},
Description: jsii.String("description"),
EnableTrustedIdentityPropagation: jsii.Boolean(false),
EnvironmentIdentifier: jsii.String("environmentIdentifier"),
ProjectIdentifier: jsii.String("projectIdentifier"),
Props: &ConnectionPropertiesInputProperty{
AmazonQProperties: &AmazonQPropertiesInputProperty{
AuthMode: jsii.String("authMode"),
IsEnabled: jsii.Boolean(false),
ProfileArn: jsii.String("profileArn"),
},
AthenaProperties: &AthenaPropertiesInputProperty{
WorkgroupName: jsii.String("workgroupName"),
},
GlueProperties: &GluePropertiesInputProperty{
GlueConnectionInput: &GlueConnectionInputProperty{
AthenaProperties: map[string]*string{
"athenaPropertiesKey": jsii.String("athenaProperties"),
},
AuthenticationConfiguration: &AuthenticationConfigurationInputProperty{
AuthenticationType: jsii.String("authenticationType"),
BasicAuthenticationCredentials: &BasicAuthenticationCredentialsProperty{
Password: jsii.String("password"),
UserName: jsii.String("userName"),
},
CustomAuthenticationCredentials: map[string]*string{
"customAuthenticationCredentialsKey": jsii.String("customAuthenticationCredentials"),
},
KmsKeyArn: jsii.String("kmsKeyArn"),
OAuth2Properties: &OAuth2PropertiesProperty{
AuthorizationCodeProperties: &AuthorizationCodePropertiesProperty{
AuthorizationCode: jsii.String("authorizationCode"),
RedirectUri: jsii.String("redirectUri"),
},
OAuth2ClientApplication: &OAuth2ClientApplicationProperty{
AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
},
OAuth2Credentials: &GlueOAuth2CredentialsProperty{
AccessToken: jsii.String("accessToken"),
JwtToken: jsii.String("jwtToken"),
RefreshToken: jsii.String("refreshToken"),
UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
},
OAuth2GrantType: jsii.String("oAuth2GrantType"),
TokenUrl: jsii.String("tokenUrl"),
TokenUrlParametersMap: map[string]*string{
"tokenUrlParametersMapKey": jsii.String("tokenUrlParametersMap"),
},
},
SecretArn: jsii.String("secretArn"),
},
ConnectionProperties: map[string]*string{
"connectionPropertiesKey": jsii.String("connectionProperties"),
},
ConnectionType: jsii.String("connectionType"),
Description: jsii.String("description"),
MatchCriteria: jsii.String("matchCriteria"),
Name: jsii.String("name"),
PhysicalConnectionRequirements: &PhysicalConnectionRequirementsProperty{
AvailabilityZone: jsii.String("availabilityZone"),
SecurityGroupIdList: []*string{
jsii.String("securityGroupIdList"),
},
SubnetId: jsii.String("subnetId"),
SubnetIdList: []*string{
jsii.String("subnetIdList"),
},
},
PythonProperties: map[string]*string{
"pythonPropertiesKey": jsii.String("pythonProperties"),
},
SparkProperties: map[string]*string{
"sparkPropertiesKey": jsii.String("sparkProperties"),
},
ValidateCredentials: jsii.Boolean(false),
ValidateForComputeEnvironments: []*string{
jsii.String("validateForComputeEnvironments"),
},
},
},
HyperPodProperties: &HyperPodPropertiesInputProperty{
ClusterName: jsii.String("clusterName"),
},
IamProperties: &IamPropertiesInputProperty{
GlueLineageSyncEnabled: jsii.Boolean(false),
},
RedshiftProperties: &RedshiftPropertiesInputProperty{
Credentials: &RedshiftCredentialsProperty{
SecretArn: jsii.String("secretArn"),
UsernamePassword: &UsernamePasswordProperty{
Password: jsii.String("password"),
Username: jsii.String("username"),
},
},
DatabaseName: jsii.String("databaseName"),
Host: jsii.String("host"),
LineageSync: &RedshiftLineageSyncConfigurationInputProperty{
Enabled: jsii.Boolean(false),
Schedule: &LineageSyncScheduleProperty{
Schedule: jsii.String("schedule"),
},
},
Port: jsii.Number(123),
Storage: &RedshiftStoragePropertiesProperty{
ClusterName: jsii.String("clusterName"),
WorkgroupName: jsii.String("workgroupName"),
},
},
S3Properties: &S3PropertiesInputProperty{
S3Uri: jsii.String("s3Uri"),
// the properties below are optional
S3AccessGrantLocationId: jsii.String("s3AccessGrantLocationId"),
},
SparkEmrProperties: &SparkEmrPropertiesInputProperty{
ComputeArn: jsii.String("computeArn"),
InstanceProfileArn: jsii.String("instanceProfileArn"),
JavaVirtualEnv: jsii.String("javaVirtualEnv"),
LogUri: jsii.String("logUri"),
PythonVirtualEnv: jsii.String("pythonVirtualEnv"),
RuntimeRole: jsii.String("runtimeRole"),
TrustedCertificatesS3Uri: jsii.String("trustedCertificatesS3Uri"),
},
SparkGlueProperties: &SparkGluePropertiesInputProperty{
AdditionalArgs: &SparkGlueArgsProperty{
Connection: jsii.String("connection"),
},
GlueConnectionName: jsii.String("glueConnectionName"),
GlueVersion: jsii.String("glueVersion"),
IdleTimeout: jsii.Number(123),
JavaVirtualEnv: jsii.String("javaVirtualEnv"),
NumberOfWorkers: jsii.Number(123),
PythonVirtualEnv: jsii.String("pythonVirtualEnv"),
WorkerType: jsii.String("workerType"),
},
},
Scope: jsii.String("scope"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-connection.html
type CfnConnection_AmazonQPropertiesInputProperty ¶ added in v2.224.0
type CfnConnection_AmazonQPropertiesInputProperty struct {
// The authentication mode of the connection's AmazonQ properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html#cfn-datazone-connection-amazonqpropertiesinput-authmode
//
AuthMode *string `field:"optional" json:"authMode" yaml:"authMode"`
// Specifies whether Amazon Q is enabled for the connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html#cfn-datazone-connection-amazonqpropertiesinput-isenabled
//
IsEnabled interface{} `field:"optional" json:"isEnabled" yaml:"isEnabled"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-amazonqpropertiesinput.html#cfn-datazone-connection-amazonqpropertiesinput-profilearn
//
ProfileArn *string `field:"optional" json:"profileArn" yaml:"profileArn"`
}
Amazon Q properties of the connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
amazonQPropertiesInputProperty := &AmazonQPropertiesInputProperty{
AuthMode: jsii.String("authMode"),
IsEnabled: jsii.Boolean(false),
ProfileArn: jsii.String("profileArn"),
}
type CfnConnection_AthenaPropertiesInputProperty ¶ added in v2.186.0
type CfnConnection_AthenaPropertiesInputProperty struct {
// The Amazon Athena workgroup name of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-athenapropertiesinput.html#cfn-datazone-connection-athenapropertiesinput-workgroupname
//
WorkgroupName *string `field:"required" json:"workgroupName" yaml:"workgroupName"`
}
The Amazon Athena properties of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
athenaPropertiesInputProperty := &AthenaPropertiesInputProperty{
WorkgroupName: jsii.String("workgroupName"),
}
type CfnConnection_AuthenticationConfigurationInputProperty ¶ added in v2.186.0
type CfnConnection_AuthenticationConfigurationInputProperty struct {
// The authentication type of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-authenticationtype
//
AuthenticationType *string `field:"optional" json:"authenticationType" yaml:"authenticationType"`
// The basic authentication credentials of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-basicauthenticationcredentials
//
BasicAuthenticationCredentials interface{} `field:"optional" json:"basicAuthenticationCredentials" yaml:"basicAuthenticationCredentials"`
// The custom authentication credentials of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-customauthenticationcredentials
//
CustomAuthenticationCredentials interface{} `field:"optional" json:"customAuthenticationCredentials" yaml:"customAuthenticationCredentials"`
// The KMS key ARN of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-kmskeyarn
//
KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
// The oAuth2 properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-oauth2properties
//
OAuth2Properties interface{} `field:"optional" json:"oAuth2Properties" yaml:"oAuth2Properties"`
// The secret ARN of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authenticationconfigurationinput.html#cfn-datazone-connection-authenticationconfigurationinput-secretarn
//
SecretArn *string `field:"optional" json:"secretArn" yaml:"secretArn"`
}
The authentication configuration of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
authenticationConfigurationInputProperty := &AuthenticationConfigurationInputProperty{
AuthenticationType: jsii.String("authenticationType"),
BasicAuthenticationCredentials: &BasicAuthenticationCredentialsProperty{
Password: jsii.String("password"),
UserName: jsii.String("userName"),
},
CustomAuthenticationCredentials: map[string]*string{
"customAuthenticationCredentialsKey": jsii.String("customAuthenticationCredentials"),
},
KmsKeyArn: jsii.String("kmsKeyArn"),
OAuth2Properties: &OAuth2PropertiesProperty{
AuthorizationCodeProperties: &AuthorizationCodePropertiesProperty{
AuthorizationCode: jsii.String("authorizationCode"),
RedirectUri: jsii.String("redirectUri"),
},
OAuth2ClientApplication: &OAuth2ClientApplicationProperty{
AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
},
OAuth2Credentials: &GlueOAuth2CredentialsProperty{
AccessToken: jsii.String("accessToken"),
JwtToken: jsii.String("jwtToken"),
RefreshToken: jsii.String("refreshToken"),
UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
},
OAuth2GrantType: jsii.String("oAuth2GrantType"),
TokenUrl: jsii.String("tokenUrl"),
TokenUrlParametersMap: map[string]*string{
"tokenUrlParametersMapKey": jsii.String("tokenUrlParametersMap"),
},
},
SecretArn: jsii.String("secretArn"),
}
type CfnConnection_AuthorizationCodePropertiesProperty ¶ added in v2.186.0
type CfnConnection_AuthorizationCodePropertiesProperty struct {
// The authorization code of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authorizationcodeproperties.html#cfn-datazone-connection-authorizationcodeproperties-authorizationcode
//
AuthorizationCode *string `field:"optional" json:"authorizationCode" yaml:"authorizationCode"`
// The redirect URI of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-authorizationcodeproperties.html#cfn-datazone-connection-authorizationcodeproperties-redirecturi
//
RedirectUri *string `field:"optional" json:"redirectUri" yaml:"redirectUri"`
}
The authorization code properties of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
authorizationCodePropertiesProperty := &AuthorizationCodePropertiesProperty{
AuthorizationCode: jsii.String("authorizationCode"),
RedirectUri: jsii.String("redirectUri"),
}
type CfnConnection_AwsLocationProperty ¶ added in v2.186.0
type CfnConnection_AwsLocationProperty struct {
// The access role of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-accessrole
//
AccessRole *string `field:"optional" json:"accessRole" yaml:"accessRole"`
// The account ID of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-awsaccountid
//
AwsAccountId *string `field:"optional" json:"awsAccountId" yaml:"awsAccountId"`
// The Region of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-awsregion
//
AwsRegion *string `field:"optional" json:"awsRegion" yaml:"awsRegion"`
// The IAM connection ID of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-awslocation.html#cfn-datazone-connection-awslocation-iamconnectionid
//
IamConnectionId *string `field:"optional" json:"iamConnectionId" yaml:"iamConnectionId"`
}
The location of a project.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
awsLocationProperty := &AwsLocationProperty{
AccessRole: jsii.String("accessRole"),
AwsAccountId: jsii.String("awsAccountId"),
AwsRegion: jsii.String("awsRegion"),
IamConnectionId: jsii.String("iamConnectionId"),
}
type CfnConnection_BasicAuthenticationCredentialsProperty ¶ added in v2.186.0
type CfnConnection_BasicAuthenticationCredentialsProperty struct {
// The password for a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-basicauthenticationcredentials.html#cfn-datazone-connection-basicauthenticationcredentials-password
//
Password *string `field:"optional" json:"password" yaml:"password"`
// The user name for the connecion.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-basicauthenticationcredentials.html#cfn-datazone-connection-basicauthenticationcredentials-username
//
UserName *string `field:"optional" json:"userName" yaml:"userName"`
}
The basic authentication credentials of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
basicAuthenticationCredentialsProperty := &BasicAuthenticationCredentialsProperty{
Password: jsii.String("password"),
UserName: jsii.String("userName"),
}
type CfnConnection_ConnectionPropertiesInputProperty ¶ added in v2.186.0
type CfnConnection_ConnectionPropertiesInputProperty struct {
// Amazon Q properties of the connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-amazonqproperties
//
AmazonQProperties interface{} `field:"optional" json:"amazonQProperties" yaml:"amazonQProperties"`
// The Amazon Athena properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-athenaproperties
//
AthenaProperties interface{} `field:"optional" json:"athenaProperties" yaml:"athenaProperties"`
// The AWS Glue properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-glueproperties
//
GlueProperties interface{} `field:"optional" json:"glueProperties" yaml:"glueProperties"`
// The hyper pod properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-hyperpodproperties
//
HyperPodProperties interface{} `field:"optional" json:"hyperPodProperties" yaml:"hyperPodProperties"`
// The IAM properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-iamproperties
//
IamProperties interface{} `field:"optional" json:"iamProperties" yaml:"iamProperties"`
// The Amazon Redshift properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-redshiftproperties
//
RedshiftProperties interface{} `field:"optional" json:"redshiftProperties" yaml:"redshiftProperties"`
// S3 Properties Input.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-s3properties
//
S3Properties interface{} `field:"optional" json:"s3Properties" yaml:"s3Properties"`
// The Spark EMR properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-sparkemrproperties
//
SparkEmrProperties interface{} `field:"optional" json:"sparkEmrProperties" yaml:"sparkEmrProperties"`
// The Spark AWS Glue properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-connectionpropertiesinput.html#cfn-datazone-connection-connectionpropertiesinput-sparkglueproperties
//
SparkGlueProperties interface{} `field:"optional" json:"sparkGlueProperties" yaml:"sparkGlueProperties"`
}
The properties of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
connectionPropertiesInputProperty := &ConnectionPropertiesInputProperty{
AmazonQProperties: &AmazonQPropertiesInputProperty{
AuthMode: jsii.String("authMode"),
IsEnabled: jsii.Boolean(false),
ProfileArn: jsii.String("profileArn"),
},
AthenaProperties: &AthenaPropertiesInputProperty{
WorkgroupName: jsii.String("workgroupName"),
},
GlueProperties: &GluePropertiesInputProperty{
GlueConnectionInput: &GlueConnectionInputProperty{
AthenaProperties: map[string]*string{
"athenaPropertiesKey": jsii.String("athenaProperties"),
},
AuthenticationConfiguration: &AuthenticationConfigurationInputProperty{
AuthenticationType: jsii.String("authenticationType"),
BasicAuthenticationCredentials: &BasicAuthenticationCredentialsProperty{
Password: jsii.String("password"),
UserName: jsii.String("userName"),
},
CustomAuthenticationCredentials: map[string]*string{
"customAuthenticationCredentialsKey": jsii.String("customAuthenticationCredentials"),
},
KmsKeyArn: jsii.String("kmsKeyArn"),
OAuth2Properties: &OAuth2PropertiesProperty{
AuthorizationCodeProperties: &AuthorizationCodePropertiesProperty{
AuthorizationCode: jsii.String("authorizationCode"),
RedirectUri: jsii.String("redirectUri"),
},
OAuth2ClientApplication: &OAuth2ClientApplicationProperty{
AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
},
OAuth2Credentials: &GlueOAuth2CredentialsProperty{
AccessToken: jsii.String("accessToken"),
JwtToken: jsii.String("jwtToken"),
RefreshToken: jsii.String("refreshToken"),
UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
},
OAuth2GrantType: jsii.String("oAuth2GrantType"),
TokenUrl: jsii.String("tokenUrl"),
TokenUrlParametersMap: map[string]*string{
"tokenUrlParametersMapKey": jsii.String("tokenUrlParametersMap"),
},
},
SecretArn: jsii.String("secretArn"),
},
ConnectionProperties: map[string]*string{
"connectionPropertiesKey": jsii.String("connectionProperties"),
},
ConnectionType: jsii.String("connectionType"),
Description: jsii.String("description"),
MatchCriteria: jsii.String("matchCriteria"),
Name: jsii.String("name"),
PhysicalConnectionRequirements: &PhysicalConnectionRequirementsProperty{
AvailabilityZone: jsii.String("availabilityZone"),
SecurityGroupIdList: []*string{
jsii.String("securityGroupIdList"),
},
SubnetId: jsii.String("subnetId"),
SubnetIdList: []*string{
jsii.String("subnetIdList"),
},
},
PythonProperties: map[string]*string{
"pythonPropertiesKey": jsii.String("pythonProperties"),
},
SparkProperties: map[string]*string{
"sparkPropertiesKey": jsii.String("sparkProperties"),
},
ValidateCredentials: jsii.Boolean(false),
ValidateForComputeEnvironments: []*string{
jsii.String("validateForComputeEnvironments"),
},
},
},
HyperPodProperties: &HyperPodPropertiesInputProperty{
ClusterName: jsii.String("clusterName"),
},
IamProperties: &IamPropertiesInputProperty{
GlueLineageSyncEnabled: jsii.Boolean(false),
},
RedshiftProperties: &RedshiftPropertiesInputProperty{
Credentials: &RedshiftCredentialsProperty{
SecretArn: jsii.String("secretArn"),
UsernamePassword: &UsernamePasswordProperty{
Password: jsii.String("password"),
Username: jsii.String("username"),
},
},
DatabaseName: jsii.String("databaseName"),
Host: jsii.String("host"),
LineageSync: &RedshiftLineageSyncConfigurationInputProperty{
Enabled: jsii.Boolean(false),
Schedule: &LineageSyncScheduleProperty{
Schedule: jsii.String("schedule"),
},
},
Port: jsii.Number(123),
Storage: &RedshiftStoragePropertiesProperty{
ClusterName: jsii.String("clusterName"),
WorkgroupName: jsii.String("workgroupName"),
},
},
S3Properties: &S3PropertiesInputProperty{
S3Uri: jsii.String("s3Uri"),
// the properties below are optional
S3AccessGrantLocationId: jsii.String("s3AccessGrantLocationId"),
},
SparkEmrProperties: &SparkEmrPropertiesInputProperty{
ComputeArn: jsii.String("computeArn"),
InstanceProfileArn: jsii.String("instanceProfileArn"),
JavaVirtualEnv: jsii.String("javaVirtualEnv"),
LogUri: jsii.String("logUri"),
PythonVirtualEnv: jsii.String("pythonVirtualEnv"),
RuntimeRole: jsii.String("runtimeRole"),
TrustedCertificatesS3Uri: jsii.String("trustedCertificatesS3Uri"),
},
SparkGlueProperties: &SparkGluePropertiesInputProperty{
AdditionalArgs: &SparkGlueArgsProperty{
Connection: jsii.String("connection"),
},
GlueConnectionName: jsii.String("glueConnectionName"),
GlueVersion: jsii.String("glueVersion"),
IdleTimeout: jsii.Number(123),
JavaVirtualEnv: jsii.String("javaVirtualEnv"),
NumberOfWorkers: jsii.Number(123),
PythonVirtualEnv: jsii.String("pythonVirtualEnv"),
WorkerType: jsii.String("workerType"),
},
}
type CfnConnection_GlueConnectionInputProperty ¶ added in v2.186.0
type CfnConnection_GlueConnectionInputProperty struct {
// The Amazon Athena properties of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-athenaproperties
//
AthenaProperties interface{} `field:"optional" json:"athenaProperties" yaml:"athenaProperties"`
// The authentication configuration of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-authenticationconfiguration
//
AuthenticationConfiguration interface{} `field:"optional" json:"authenticationConfiguration" yaml:"authenticationConfiguration"`
// The connection properties of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-connectionproperties
//
ConnectionProperties interface{} `field:"optional" json:"connectionProperties" yaml:"connectionProperties"`
// The connection type of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-connectiontype
//
ConnectionType *string `field:"optional" json:"connectionType" yaml:"connectionType"`
// The description of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The match criteria of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-matchcriteria
//
MatchCriteria *string `field:"optional" json:"matchCriteria" yaml:"matchCriteria"`
// The name of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The physical connection requirements for the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-physicalconnectionrequirements
//
PhysicalConnectionRequirements interface{} `field:"optional" json:"physicalConnectionRequirements" yaml:"physicalConnectionRequirements"`
// The Python properties of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-pythonproperties
//
PythonProperties interface{} `field:"optional" json:"pythonProperties" yaml:"pythonProperties"`
// The Spark properties of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-sparkproperties
//
SparkProperties interface{} `field:"optional" json:"sparkProperties" yaml:"sparkProperties"`
// Speciefies whether to validate credentials of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-validatecredentials
//
ValidateCredentials interface{} `field:"optional" json:"validateCredentials" yaml:"validateCredentials"`
// Speciefies whether to validate for compute environments of the AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueconnectioninput.html#cfn-datazone-connection-glueconnectioninput-validateforcomputeenvironments
//
ValidateForComputeEnvironments *[]*string `field:"optional" json:"validateForComputeEnvironments" yaml:"validateForComputeEnvironments"`
}
The AWS Glue connecton input.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
glueConnectionInputProperty := &GlueConnectionInputProperty{
AthenaProperties: map[string]*string{
"athenaPropertiesKey": jsii.String("athenaProperties"),
},
AuthenticationConfiguration: &AuthenticationConfigurationInputProperty{
AuthenticationType: jsii.String("authenticationType"),
BasicAuthenticationCredentials: &BasicAuthenticationCredentialsProperty{
Password: jsii.String("password"),
UserName: jsii.String("userName"),
},
CustomAuthenticationCredentials: map[string]*string{
"customAuthenticationCredentialsKey": jsii.String("customAuthenticationCredentials"),
},
KmsKeyArn: jsii.String("kmsKeyArn"),
OAuth2Properties: &OAuth2PropertiesProperty{
AuthorizationCodeProperties: &AuthorizationCodePropertiesProperty{
AuthorizationCode: jsii.String("authorizationCode"),
RedirectUri: jsii.String("redirectUri"),
},
OAuth2ClientApplication: &OAuth2ClientApplicationProperty{
AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
},
OAuth2Credentials: &GlueOAuth2CredentialsProperty{
AccessToken: jsii.String("accessToken"),
JwtToken: jsii.String("jwtToken"),
RefreshToken: jsii.String("refreshToken"),
UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
},
OAuth2GrantType: jsii.String("oAuth2GrantType"),
TokenUrl: jsii.String("tokenUrl"),
TokenUrlParametersMap: map[string]*string{
"tokenUrlParametersMapKey": jsii.String("tokenUrlParametersMap"),
},
},
SecretArn: jsii.String("secretArn"),
},
ConnectionProperties: map[string]*string{
"connectionPropertiesKey": jsii.String("connectionProperties"),
},
ConnectionType: jsii.String("connectionType"),
Description: jsii.String("description"),
MatchCriteria: jsii.String("matchCriteria"),
Name: jsii.String("name"),
PhysicalConnectionRequirements: &PhysicalConnectionRequirementsProperty{
AvailabilityZone: jsii.String("availabilityZone"),
SecurityGroupIdList: []*string{
jsii.String("securityGroupIdList"),
},
SubnetId: jsii.String("subnetId"),
SubnetIdList: []*string{
jsii.String("subnetIdList"),
},
},
PythonProperties: map[string]*string{
"pythonPropertiesKey": jsii.String("pythonProperties"),
},
SparkProperties: map[string]*string{
"sparkPropertiesKey": jsii.String("sparkProperties"),
},
ValidateCredentials: jsii.Boolean(false),
ValidateForComputeEnvironments: []*string{
jsii.String("validateForComputeEnvironments"),
},
}
type CfnConnection_GlueOAuth2CredentialsProperty ¶ added in v2.186.0
type CfnConnection_GlueOAuth2CredentialsProperty struct {
// The access token of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-accesstoken
//
AccessToken *string `field:"optional" json:"accessToken" yaml:"accessToken"`
// The jwt token of the connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-jwttoken
//
JwtToken *string `field:"optional" json:"jwtToken" yaml:"jwtToken"`
// The refresh token of the connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-refreshtoken
//
RefreshToken *string `field:"optional" json:"refreshToken" yaml:"refreshToken"`
// The user managed client application client secret of the connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-glueoauth2credentials.html#cfn-datazone-connection-glueoauth2credentials-usermanagedclientapplicationclientsecret
//
UserManagedClientApplicationClientSecret *string `field:"optional" json:"userManagedClientApplicationClientSecret" yaml:"userManagedClientApplicationClientSecret"`
}
The GlueOAuth2 credentials of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
glueOAuth2CredentialsProperty := &GlueOAuth2CredentialsProperty{
AccessToken: jsii.String("accessToken"),
JwtToken: jsii.String("jwtToken"),
RefreshToken: jsii.String("refreshToken"),
UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
}
type CfnConnection_GluePropertiesInputProperty ¶ added in v2.186.0
type CfnConnection_GluePropertiesInputProperty struct {
// The AWS Glue connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-gluepropertiesinput.html#cfn-datazone-connection-gluepropertiesinput-glueconnectioninput
//
GlueConnectionInput interface{} `field:"optional" json:"glueConnectionInput" yaml:"glueConnectionInput"`
}
The AWS Glue properties of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
gluePropertiesInputProperty := &GluePropertiesInputProperty{
GlueConnectionInput: &GlueConnectionInputProperty{
AthenaProperties: map[string]*string{
"athenaPropertiesKey": jsii.String("athenaProperties"),
},
AuthenticationConfiguration: &AuthenticationConfigurationInputProperty{
AuthenticationType: jsii.String("authenticationType"),
BasicAuthenticationCredentials: &BasicAuthenticationCredentialsProperty{
Password: jsii.String("password"),
UserName: jsii.String("userName"),
},
CustomAuthenticationCredentials: map[string]*string{
"customAuthenticationCredentialsKey": jsii.String("customAuthenticationCredentials"),
},
KmsKeyArn: jsii.String("kmsKeyArn"),
OAuth2Properties: &OAuth2PropertiesProperty{
AuthorizationCodeProperties: &AuthorizationCodePropertiesProperty{
AuthorizationCode: jsii.String("authorizationCode"),
RedirectUri: jsii.String("redirectUri"),
},
OAuth2ClientApplication: &OAuth2ClientApplicationProperty{
AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
},
OAuth2Credentials: &GlueOAuth2CredentialsProperty{
AccessToken: jsii.String("accessToken"),
JwtToken: jsii.String("jwtToken"),
RefreshToken: jsii.String("refreshToken"),
UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
},
OAuth2GrantType: jsii.String("oAuth2GrantType"),
TokenUrl: jsii.String("tokenUrl"),
TokenUrlParametersMap: map[string]*string{
"tokenUrlParametersMapKey": jsii.String("tokenUrlParametersMap"),
},
},
SecretArn: jsii.String("secretArn"),
},
ConnectionProperties: map[string]*string{
"connectionPropertiesKey": jsii.String("connectionProperties"),
},
ConnectionType: jsii.String("connectionType"),
Description: jsii.String("description"),
MatchCriteria: jsii.String("matchCriteria"),
Name: jsii.String("name"),
PhysicalConnectionRequirements: &PhysicalConnectionRequirementsProperty{
AvailabilityZone: jsii.String("availabilityZone"),
SecurityGroupIdList: []*string{
jsii.String("securityGroupIdList"),
},
SubnetId: jsii.String("subnetId"),
SubnetIdList: []*string{
jsii.String("subnetIdList"),
},
},
PythonProperties: map[string]*string{
"pythonPropertiesKey": jsii.String("pythonProperties"),
},
SparkProperties: map[string]*string{
"sparkPropertiesKey": jsii.String("sparkProperties"),
},
ValidateCredentials: jsii.Boolean(false),
ValidateForComputeEnvironments: []*string{
jsii.String("validateForComputeEnvironments"),
},
},
}
type CfnConnection_HyperPodPropertiesInputProperty ¶ added in v2.186.0
type CfnConnection_HyperPodPropertiesInputProperty struct {
// The cluster name the hyper pod properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-hyperpodpropertiesinput.html#cfn-datazone-connection-hyperpodpropertiesinput-clustername
//
ClusterName *string `field:"required" json:"clusterName" yaml:"clusterName"`
}
The hyper pod properties of a AWS Glue properties patch.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
hyperPodPropertiesInputProperty := &HyperPodPropertiesInputProperty{
ClusterName: jsii.String("clusterName"),
}
type CfnConnection_IamPropertiesInputProperty ¶ added in v2.186.0
type CfnConnection_IamPropertiesInputProperty struct {
// Specifies whether AWS Glue lineage sync is enabled for a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-iampropertiesinput.html#cfn-datazone-connection-iampropertiesinput-gluelineagesyncenabled
//
GlueLineageSyncEnabled interface{} `field:"optional" json:"glueLineageSyncEnabled" yaml:"glueLineageSyncEnabled"`
}
The IAM properties of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
iamPropertiesInputProperty := &IamPropertiesInputProperty{
GlueLineageSyncEnabled: jsii.Boolean(false),
}
type CfnConnection_LineageSyncScheduleProperty ¶ added in v2.186.0
type CfnConnection_LineageSyncScheduleProperty struct {
// The lineage sync schedule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-lineagesyncschedule.html#cfn-datazone-connection-lineagesyncschedule-schedule
//
Schedule *string `field:"optional" json:"schedule" yaml:"schedule"`
}
The lineage sync schedule.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
lineageSyncScheduleProperty := &LineageSyncScheduleProperty{
Schedule: jsii.String("schedule"),
}
type CfnConnection_OAuth2ClientApplicationProperty ¶ added in v2.186.0
type CfnConnection_OAuth2ClientApplicationProperty struct {
// The AWS managed client application reference in the OAuth2Client application.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2clientapplication.html#cfn-datazone-connection-oauth2clientapplication-awsmanagedclientapplicationreference
//
AwsManagedClientApplicationReference *string `field:"optional" json:"awsManagedClientApplicationReference" yaml:"awsManagedClientApplicationReference"`
// The user managed client application client ID in the OAuth2Client application.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2clientapplication.html#cfn-datazone-connection-oauth2clientapplication-usermanagedclientapplicationclientid
//
UserManagedClientApplicationClientId *string `field:"optional" json:"userManagedClientApplicationClientId" yaml:"userManagedClientApplicationClientId"`
}
The OAuth2Client application.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
oAuth2ClientApplicationProperty := &OAuth2ClientApplicationProperty{
AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
}
type CfnConnection_OAuth2PropertiesProperty ¶ added in v2.186.0
type CfnConnection_OAuth2PropertiesProperty struct {
// The authorization code properties of the OAuth2 properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-authorizationcodeproperties
//
AuthorizationCodeProperties interface{} `field:"optional" json:"authorizationCodeProperties" yaml:"authorizationCodeProperties"`
// The OAuth2 client application of the OAuth2 properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-oauth2clientapplication
//
OAuth2ClientApplication interface{} `field:"optional" json:"oAuth2ClientApplication" yaml:"oAuth2ClientApplication"`
// The OAuth2 credentials of the OAuth2 properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-oauth2credentials
//
OAuth2Credentials interface{} `field:"optional" json:"oAuth2Credentials" yaml:"oAuth2Credentials"`
// The OAuth2 grant type of the OAuth2 properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-oauth2granttype
//
OAuth2GrantType *string `field:"optional" json:"oAuth2GrantType" yaml:"oAuth2GrantType"`
// The OAuth2 token URL of the OAuth2 properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-tokenurl
//
TokenUrl *string `field:"optional" json:"tokenUrl" yaml:"tokenUrl"`
// The OAuth2 token URL parameter map of the OAuth2 properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-oauth2properties.html#cfn-datazone-connection-oauth2properties-tokenurlparametersmap
//
TokenUrlParametersMap interface{} `field:"optional" json:"tokenUrlParametersMap" yaml:"tokenUrlParametersMap"`
}
The OAuth2 properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
oAuth2PropertiesProperty := &OAuth2PropertiesProperty{
AuthorizationCodeProperties: &AuthorizationCodePropertiesProperty{
AuthorizationCode: jsii.String("authorizationCode"),
RedirectUri: jsii.String("redirectUri"),
},
OAuth2ClientApplication: &OAuth2ClientApplicationProperty{
AwsManagedClientApplicationReference: jsii.String("awsManagedClientApplicationReference"),
UserManagedClientApplicationClientId: jsii.String("userManagedClientApplicationClientId"),
},
OAuth2Credentials: &GlueOAuth2CredentialsProperty{
AccessToken: jsii.String("accessToken"),
JwtToken: jsii.String("jwtToken"),
RefreshToken: jsii.String("refreshToken"),
UserManagedClientApplicationClientSecret: jsii.String("userManagedClientApplicationClientSecret"),
},
OAuth2GrantType: jsii.String("oAuth2GrantType"),
TokenUrl: jsii.String("tokenUrl"),
TokenUrlParametersMap: map[string]*string{
"tokenUrlParametersMapKey": jsii.String("tokenUrlParametersMap"),
},
}
type CfnConnection_PhysicalConnectionRequirementsProperty ¶ added in v2.186.0
type CfnConnection_PhysicalConnectionRequirementsProperty struct {
// The availability zone of the physical connection requirements of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-availabilityzone
//
AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"`
// The group ID list of the physical connection requirements of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-securitygroupidlist
//
SecurityGroupIdList *[]*string `field:"optional" json:"securityGroupIdList" yaml:"securityGroupIdList"`
// The subnet ID of the physical connection requirements of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-subnetid
//
SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"`
// The subnet ID list of the physical connection requirements of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-physicalconnectionrequirements.html#cfn-datazone-connection-physicalconnectionrequirements-subnetidlist
//
SubnetIdList *[]*string `field:"optional" json:"subnetIdList" yaml:"subnetIdList"`
}
Physical connection requirements of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
physicalConnectionRequirementsProperty := &PhysicalConnectionRequirementsProperty{
AvailabilityZone: jsii.String("availabilityZone"),
SecurityGroupIdList: []*string{
jsii.String("securityGroupIdList"),
},
SubnetId: jsii.String("subnetId"),
SubnetIdList: []*string{
jsii.String("subnetIdList"),
},
}
type CfnConnection_RedshiftCredentialsProperty ¶ added in v2.186.0
type CfnConnection_RedshiftCredentialsProperty struct {
// The secret ARN of the Amazon Redshift credentials of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftcredentials.html#cfn-datazone-connection-redshiftcredentials-secretarn
//
SecretArn *string `field:"optional" json:"secretArn" yaml:"secretArn"`
// The username and password of the Amazon Redshift credentials of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftcredentials.html#cfn-datazone-connection-redshiftcredentials-usernamepassword
//
UsernamePassword interface{} `field:"optional" json:"usernamePassword" yaml:"usernamePassword"`
}
Amazon Redshift credentials of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
redshiftCredentialsProperty := &RedshiftCredentialsProperty{
SecretArn: jsii.String("secretArn"),
UsernamePassword: &UsernamePasswordProperty{
Password: jsii.String("password"),
Username: jsii.String("username"),
},
}
type CfnConnection_RedshiftLineageSyncConfigurationInputProperty ¶ added in v2.186.0
type CfnConnection_RedshiftLineageSyncConfigurationInputProperty struct {
// Specifies whether the Amaon Redshift lineage sync configuration is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.html#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
// The schedule of the Amaon Redshift lineage sync configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftlineagesyncconfigurationinput.html#cfn-datazone-connection-redshiftlineagesyncconfigurationinput-schedule
//
Schedule interface{} `field:"optional" json:"schedule" yaml:"schedule"`
}
The Amaon Redshift lineage sync configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
redshiftLineageSyncConfigurationInputProperty := &RedshiftLineageSyncConfigurationInputProperty{
Enabled: jsii.Boolean(false),
Schedule: &LineageSyncScheduleProperty{
Schedule: jsii.String("schedule"),
},
}
type CfnConnection_RedshiftPropertiesInputProperty ¶ added in v2.186.0
type CfnConnection_RedshiftPropertiesInputProperty struct {
// The Amaon Redshift credentials.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-credentials
//
Credentials interface{} `field:"optional" json:"credentials" yaml:"credentials"`
// The Amazon Redshift database name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-databasename
//
DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"`
// The Amazon Redshift host.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-host
//
Host *string `field:"optional" json:"host" yaml:"host"`
// The lineage sync of the Amazon Redshift.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-lineagesync
//
LineageSync interface{} `field:"optional" json:"lineageSync" yaml:"lineageSync"`
// The Amaon Redshift port.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-port
//
Port *float64 `field:"optional" json:"port" yaml:"port"`
// The Amazon Redshift storage.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftpropertiesinput.html#cfn-datazone-connection-redshiftpropertiesinput-storage
//
Storage interface{} `field:"optional" json:"storage" yaml:"storage"`
}
The Amazon Redshift properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
redshiftPropertiesInputProperty := &RedshiftPropertiesInputProperty{
Credentials: &RedshiftCredentialsProperty{
SecretArn: jsii.String("secretArn"),
UsernamePassword: &UsernamePasswordProperty{
Password: jsii.String("password"),
Username: jsii.String("username"),
},
},
DatabaseName: jsii.String("databaseName"),
Host: jsii.String("host"),
LineageSync: &RedshiftLineageSyncConfigurationInputProperty{
Enabled: jsii.Boolean(false),
Schedule: &LineageSyncScheduleProperty{
Schedule: jsii.String("schedule"),
},
},
Port: jsii.Number(123),
Storage: &RedshiftStoragePropertiesProperty{
ClusterName: jsii.String("clusterName"),
WorkgroupName: jsii.String("workgroupName"),
},
}
type CfnConnection_RedshiftStoragePropertiesProperty ¶ added in v2.186.0
type CfnConnection_RedshiftStoragePropertiesProperty struct {
// The cluster name in the Amazon Redshift storage properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftstorageproperties.html#cfn-datazone-connection-redshiftstorageproperties-clustername
//
ClusterName *string `field:"optional" json:"clusterName" yaml:"clusterName"`
// The workgroup name in the Amazon Redshift storage properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-redshiftstorageproperties.html#cfn-datazone-connection-redshiftstorageproperties-workgroupname
//
WorkgroupName *string `field:"optional" json:"workgroupName" yaml:"workgroupName"`
}
The Amazon Redshift storage properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
redshiftStoragePropertiesProperty := &RedshiftStoragePropertiesProperty{
ClusterName: jsii.String("clusterName"),
WorkgroupName: jsii.String("workgroupName"),
}
type CfnConnection_S3PropertiesInputProperty ¶ added in v2.223.0
type CfnConnection_S3PropertiesInputProperty struct {
// The Amazon S3 URI that's part of the Amazon S3 properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-s3propertiesinput.html#cfn-datazone-connection-s3propertiesinput-s3uri
//
S3Uri *string `field:"required" json:"s3Uri" yaml:"s3Uri"`
// The Amazon S3 Access Grant location ID that's part of the Amazon S3 properties of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-s3propertiesinput.html#cfn-datazone-connection-s3propertiesinput-s3accessgrantlocationid
//
S3AccessGrantLocationId *string `field:"optional" json:"s3AccessGrantLocationId" yaml:"s3AccessGrantLocationId"`
}
S3 Properties Input.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3PropertiesInputProperty := &S3PropertiesInputProperty{
S3Uri: jsii.String("s3Uri"),
// the properties below are optional
S3AccessGrantLocationId: jsii.String("s3AccessGrantLocationId"),
}
type CfnConnection_SparkEmrPropertiesInputProperty ¶ added in v2.186.0
type CfnConnection_SparkEmrPropertiesInputProperty struct {
// The compute ARN of Spark EMR.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-computearn
//
ComputeArn *string `field:"optional" json:"computeArn" yaml:"computeArn"`
// The instance profile ARN of Spark EMR.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-instanceprofilearn
//
InstanceProfileArn *string `field:"optional" json:"instanceProfileArn" yaml:"instanceProfileArn"`
// The java virtual env of the Spark EMR.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-javavirtualenv
//
JavaVirtualEnv *string `field:"optional" json:"javaVirtualEnv" yaml:"javaVirtualEnv"`
// The log URI of the Spark EMR.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-loguri
//
LogUri *string `field:"optional" json:"logUri" yaml:"logUri"`
// The Python virtual env of the Spark EMR.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-pythonvirtualenv
//
PythonVirtualEnv *string `field:"optional" json:"pythonVirtualEnv" yaml:"pythonVirtualEnv"`
// The runtime role of the Spark EMR.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-runtimerole
//
RuntimeRole *string `field:"optional" json:"runtimeRole" yaml:"runtimeRole"`
// The certificates S3 URI of the Spark EMR.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkemrpropertiesinput.html#cfn-datazone-connection-sparkemrpropertiesinput-trustedcertificatess3uri
//
TrustedCertificatesS3Uri *string `field:"optional" json:"trustedCertificatesS3Uri" yaml:"trustedCertificatesS3Uri"`
}
The Spark EMR properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sparkEmrPropertiesInputProperty := &SparkEmrPropertiesInputProperty{
ComputeArn: jsii.String("computeArn"),
InstanceProfileArn: jsii.String("instanceProfileArn"),
JavaVirtualEnv: jsii.String("javaVirtualEnv"),
LogUri: jsii.String("logUri"),
PythonVirtualEnv: jsii.String("pythonVirtualEnv"),
RuntimeRole: jsii.String("runtimeRole"),
TrustedCertificatesS3Uri: jsii.String("trustedCertificatesS3Uri"),
}
type CfnConnection_SparkGlueArgsProperty ¶ added in v2.186.0
type CfnConnection_SparkGlueArgsProperty struct {
// The connection in the Spark AWS Glue args.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkglueargs.html#cfn-datazone-connection-sparkglueargs-connection
//
Connection *string `field:"optional" json:"connection" yaml:"connection"`
}
The Spark AWS Glue args.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sparkGlueArgsProperty := &SparkGlueArgsProperty{
Connection: jsii.String("connection"),
}
type CfnConnection_SparkGluePropertiesInputProperty ¶ added in v2.186.0
type CfnConnection_SparkGluePropertiesInputProperty struct {
// The additional args in the Spark AWS Glue properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-additionalargs
//
AdditionalArgs interface{} `field:"optional" json:"additionalArgs" yaml:"additionalArgs"`
// The AWS Glue connection name in the Spark AWS Glue properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-glueconnectionname
//
GlueConnectionName *string `field:"optional" json:"glueConnectionName" yaml:"glueConnectionName"`
// The AWS Glue version in the Spark AWS Glue properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-glueversion
//
GlueVersion *string `field:"optional" json:"glueVersion" yaml:"glueVersion"`
// The idle timeout in the Spark AWS Glue properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-idletimeout
//
IdleTimeout *float64 `field:"optional" json:"idleTimeout" yaml:"idleTimeout"`
// The Java virtual env in the Spark AWS Glue properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-javavirtualenv
//
JavaVirtualEnv *string `field:"optional" json:"javaVirtualEnv" yaml:"javaVirtualEnv"`
// The number of workers in the Spark AWS Glue properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-numberofworkers
//
NumberOfWorkers *float64 `field:"optional" json:"numberOfWorkers" yaml:"numberOfWorkers"`
// The Python virtual env in the Spark AWS Glue properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-pythonvirtualenv
//
PythonVirtualEnv *string `field:"optional" json:"pythonVirtualEnv" yaml:"pythonVirtualEnv"`
// The worker type in the Spark AWS Glue properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-sparkgluepropertiesinput.html#cfn-datazone-connection-sparkgluepropertiesinput-workertype
//
WorkerType *string `field:"optional" json:"workerType" yaml:"workerType"`
}
The Spark AWS Glue properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sparkGluePropertiesInputProperty := &SparkGluePropertiesInputProperty{
AdditionalArgs: &SparkGlueArgsProperty{
Connection: jsii.String("connection"),
},
GlueConnectionName: jsii.String("glueConnectionName"),
GlueVersion: jsii.String("glueVersion"),
IdleTimeout: jsii.Number(123),
JavaVirtualEnv: jsii.String("javaVirtualEnv"),
NumberOfWorkers: jsii.Number(123),
PythonVirtualEnv: jsii.String("pythonVirtualEnv"),
WorkerType: jsii.String("workerType"),
}
type CfnConnection_UsernamePasswordProperty ¶ added in v2.186.0
type CfnConnection_UsernamePasswordProperty struct {
// The password of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-usernamepassword.html#cfn-datazone-connection-usernamepassword-password
//
Password *string `field:"required" json:"password" yaml:"password"`
// The username of a connection.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-connection-usernamepassword.html#cfn-datazone-connection-usernamepassword-username
//
Username *string `field:"required" json:"username" yaml:"username"`
}
The username and password of a connection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
usernamePasswordProperty := &UsernamePasswordProperty{
Password: jsii.String("password"),
Username: jsii.String("username"),
}
type CfnDataSource ¶
type CfnDataSource interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IDataSourceRef
// The metadata forms attached to the assets that the data source works with.
AssetFormsInput() interface{}
SetAssetFormsInput(val interface{})
// The connection ID that's part of the data source summary.
AttrConnectionId() *string
// The timestamp of when the data source was created.
AttrCreatedAt() *string
// The ID of the Amazon DataZone domain in which the data source exists.
AttrDomainId() *string
// The ID of the environment in which the data source exists.
AttrEnvironmentId() *string
// The identifier of the data source run.
AttrId() *string
// The count of the assets created during the last data source run.
AttrLastRunAssetCount() awscdk.IResolvable
// The timestamp of when the data source run was last performed.
AttrLastRunAt() *string
// The status of the last data source run.
AttrLastRunStatus() *string
// The project ID included in the data source run activity.
AttrProjectId() *string
// The status of the data source.
AttrStatus() *string
// The timestamp of when the data source was updated.
AttrUpdatedAt() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The configuration of the data source.
Configuration() interface{}
SetConfiguration(val interface{})
// The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.
ConnectionIdentifier() *string
SetConnectionIdentifier(val *string)
// 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 reference to a DataSource resource.
DataSourceRef() *interfacesawsdatazone.DataSourceReference
// The description of the data source.
Description() *string
SetDescription(val *string)
// The ID of the Amazon DataZone domain where the data source is created.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
// Specifies whether the data source is enabled.
EnableSetting() *string
SetEnableSetting(val *string)
Env() *interfaces.ResourceEnvironment
// The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
EnvironmentIdentifier() *string
SetEnvironmentIdentifier(val *string)
// 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 name of the data source.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The identifier of the Amazon DataZone project in which you want to add this data source.
ProjectIdentifier() *string
SetProjectIdentifier(val *string)
// Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
PublishOnImport() interface{}
SetPublishOnImport(val interface{})
// Specifies whether the business name generation is to be enabled for this data source.
Recommendation() interface{}
SetRecommendation(val interface{})
// 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 schedule of the data source runs.
Schedule() interface{}
SetSchedule(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The type of the data source.
Type() *string
SetType(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The `AWS::DataZone::DataSource` resource specifies an Amazon DataZone data source that is used to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDataSource := awscdk.Aws_datazone.NewCfnDataSource(this, jsii.String("MyCfnDataSource"), &CfnDataSourceProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
ProjectIdentifier: jsii.String("projectIdentifier"),
Type: jsii.String("type"),
// the properties below are optional
AssetFormsInput: []interface{}{
&FormInputProperty{
FormName: jsii.String("formName"),
// the properties below are optional
Content: jsii.String("content"),
TypeIdentifier: jsii.String("typeIdentifier"),
TypeRevision: jsii.String("typeRevision"),
},
},
Configuration: &DataSourceConfigurationInputProperty{
GlueRunConfiguration: &GlueRunConfigurationInputProperty{
RelationalFilterConfigurations: []interface{}{
&RelationalFilterConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
// the properties below are optional
FilterExpressions: []interface{}{
&FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
SchemaName: jsii.String("schemaName"),
},
},
// the properties below are optional
AutoImportDataQualityResult: jsii.Boolean(false),
CatalogName: jsii.String("catalogName"),
DataAccessRole: jsii.String("dataAccessRole"),
},
RedshiftRunConfiguration: &RedshiftRunConfigurationInputProperty{
RelationalFilterConfigurations: []interface{}{
&RelationalFilterConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
// the properties below are optional
FilterExpressions: []interface{}{
&FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
SchemaName: jsii.String("schemaName"),
},
},
// the properties below are optional
DataAccessRole: jsii.String("dataAccessRole"),
RedshiftCredentialConfiguration: &RedshiftCredentialConfigurationProperty{
SecretManagerArn: jsii.String("secretManagerArn"),
},
RedshiftStorage: &RedshiftStorageProperty{
RedshiftClusterSource: &RedshiftClusterStorageProperty{
ClusterName: jsii.String("clusterName"),
},
RedshiftServerlessSource: &RedshiftServerlessStorageProperty{
WorkgroupName: jsii.String("workgroupName"),
},
},
},
SageMakerRunConfiguration: &SageMakerRunConfigurationInputProperty{
TrackingAssets: map[string][]*string{
"trackingAssetsKey": []*string{
jsii.String("trackingAssets"),
},
},
},
},
ConnectionIdentifier: jsii.String("connectionIdentifier"),
Description: jsii.String("description"),
EnableSetting: jsii.String("enableSetting"),
EnvironmentIdentifier: jsii.String("environmentIdentifier"),
PublishOnImport: jsii.Boolean(false),
Recommendation: &RecommendationConfigurationProperty{
EnableBusinessNameGeneration: jsii.Boolean(false),
},
Schedule: &ScheduleConfigurationProperty{
Schedule: jsii.String("schedule"),
Timezone: jsii.String("timezone"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html
func NewCfnDataSource ¶
func NewCfnDataSource(scope constructs.Construct, id *string, props *CfnDataSourceProps) CfnDataSource
Create a new `AWS::DataZone::DataSource`.
type CfnDataSourceProps ¶
type CfnDataSourceProps struct {
// The ID of the Amazon DataZone domain where the data source is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The name of the data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The identifier of the Amazon DataZone project in which you want to add this data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-projectidentifier
//
ProjectIdentifier *string `field:"required" json:"projectIdentifier" yaml:"projectIdentifier"`
// The type of the data source.
//
// In Amazon DataZone, you can use data sources to import technical metadata of assets (data) from the source databases or data warehouses into Amazon DataZone. In the current release of Amazon DataZone, you can create and run data sources for AWS Glue and Amazon Redshift.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// The metadata forms attached to the assets that the data source works with.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-assetformsinput
//
AssetFormsInput interface{} `field:"optional" json:"assetFormsInput" yaml:"assetFormsInput"`
// The configuration of the data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-configuration
//
Configuration interface{} `field:"optional" json:"configuration" yaml:"configuration"`
// The unique identifier of a connection used to fetch relevant parameters from connection during Datasource run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-connectionidentifier
//
ConnectionIdentifier *string `field:"optional" json:"connectionIdentifier" yaml:"connectionIdentifier"`
// The description of the data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Specifies whether the data source is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-enablesetting
//
EnableSetting *string `field:"optional" json:"enableSetting" yaml:"enableSetting"`
// The unique identifier of the Amazon DataZone environment to which the data source publishes assets.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-environmentidentifier
//
EnvironmentIdentifier *string `field:"optional" json:"environmentIdentifier" yaml:"environmentIdentifier"`
// Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-publishonimport
//
PublishOnImport interface{} `field:"optional" json:"publishOnImport" yaml:"publishOnImport"`
// Specifies whether the business name generation is to be enabled for this data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-recommendation
//
Recommendation interface{} `field:"optional" json:"recommendation" yaml:"recommendation"`
// The schedule of the data source runs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-schedule
//
Schedule interface{} `field:"optional" json:"schedule" yaml:"schedule"`
}
Properties for defining a `CfnDataSource`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDataSourceProps := &CfnDataSourceProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
ProjectIdentifier: jsii.String("projectIdentifier"),
Type: jsii.String("type"),
// the properties below are optional
AssetFormsInput: []interface{}{
&FormInputProperty{
FormName: jsii.String("formName"),
// the properties below are optional
Content: jsii.String("content"),
TypeIdentifier: jsii.String("typeIdentifier"),
TypeRevision: jsii.String("typeRevision"),
},
},
Configuration: &DataSourceConfigurationInputProperty{
GlueRunConfiguration: &GlueRunConfigurationInputProperty{
RelationalFilterConfigurations: []interface{}{
&RelationalFilterConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
// the properties below are optional
FilterExpressions: []interface{}{
&FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
SchemaName: jsii.String("schemaName"),
},
},
// the properties below are optional
AutoImportDataQualityResult: jsii.Boolean(false),
CatalogName: jsii.String("catalogName"),
DataAccessRole: jsii.String("dataAccessRole"),
},
RedshiftRunConfiguration: &RedshiftRunConfigurationInputProperty{
RelationalFilterConfigurations: []interface{}{
&RelationalFilterConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
// the properties below are optional
FilterExpressions: []interface{}{
&FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
SchemaName: jsii.String("schemaName"),
},
},
// the properties below are optional
DataAccessRole: jsii.String("dataAccessRole"),
RedshiftCredentialConfiguration: &RedshiftCredentialConfigurationProperty{
SecretManagerArn: jsii.String("secretManagerArn"),
},
RedshiftStorage: &RedshiftStorageProperty{
RedshiftClusterSource: &RedshiftClusterStorageProperty{
ClusterName: jsii.String("clusterName"),
},
RedshiftServerlessSource: &RedshiftServerlessStorageProperty{
WorkgroupName: jsii.String("workgroupName"),
},
},
},
SageMakerRunConfiguration: &SageMakerRunConfigurationInputProperty{
TrackingAssets: map[string][]*string{
"trackingAssetsKey": []*string{
jsii.String("trackingAssets"),
},
},
},
},
ConnectionIdentifier: jsii.String("connectionIdentifier"),
Description: jsii.String("description"),
EnableSetting: jsii.String("enableSetting"),
EnvironmentIdentifier: jsii.String("environmentIdentifier"),
PublishOnImport: jsii.Boolean(false),
Recommendation: &RecommendationConfigurationProperty{
EnableBusinessNameGeneration: jsii.Boolean(false),
},
Schedule: &ScheduleConfigurationProperty{
Schedule: jsii.String("schedule"),
Timezone: jsii.String("timezone"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html
type CfnDataSource_DataSourceConfigurationInputProperty ¶
type CfnDataSource_DataSourceConfigurationInputProperty struct {
// The configuration of the AWS Glue data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-gluerunconfiguration
//
GlueRunConfiguration interface{} `field:"optional" json:"glueRunConfiguration" yaml:"glueRunConfiguration"`
// The configuration of the Amazon Redshift data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-redshiftrunconfiguration
//
RedshiftRunConfiguration interface{} `field:"optional" json:"redshiftRunConfiguration" yaml:"redshiftRunConfiguration"`
// The configuration details of the Amazon SageMaker data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-sagemakerrunconfiguration
//
SageMakerRunConfiguration interface{} `field:"optional" json:"sageMakerRunConfiguration" yaml:"sageMakerRunConfiguration"`
}
The configuration of the data source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
dataSourceConfigurationInputProperty := &DataSourceConfigurationInputProperty{
GlueRunConfiguration: &GlueRunConfigurationInputProperty{
RelationalFilterConfigurations: []interface{}{
&RelationalFilterConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
// the properties below are optional
FilterExpressions: []interface{}{
&FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
SchemaName: jsii.String("schemaName"),
},
},
// the properties below are optional
AutoImportDataQualityResult: jsii.Boolean(false),
CatalogName: jsii.String("catalogName"),
DataAccessRole: jsii.String("dataAccessRole"),
},
RedshiftRunConfiguration: &RedshiftRunConfigurationInputProperty{
RelationalFilterConfigurations: []interface{}{
&RelationalFilterConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
// the properties below are optional
FilterExpressions: []interface{}{
&FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
SchemaName: jsii.String("schemaName"),
},
},
// the properties below are optional
DataAccessRole: jsii.String("dataAccessRole"),
RedshiftCredentialConfiguration: &RedshiftCredentialConfigurationProperty{
SecretManagerArn: jsii.String("secretManagerArn"),
},
RedshiftStorage: &RedshiftStorageProperty{
RedshiftClusterSource: &RedshiftClusterStorageProperty{
ClusterName: jsii.String("clusterName"),
},
RedshiftServerlessSource: &RedshiftServerlessStorageProperty{
WorkgroupName: jsii.String("workgroupName"),
},
},
},
SageMakerRunConfiguration: &SageMakerRunConfigurationInputProperty{
TrackingAssets: map[string][]*string{
"trackingAssetsKey": []*string{
jsii.String("trackingAssets"),
},
},
},
}
type CfnDataSource_FilterExpressionProperty ¶
type CfnDataSource_FilterExpressionProperty struct {
// The search filter expression.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.html#cfn-datazone-datasource-filterexpression-expression
//
Expression *string `field:"required" json:"expression" yaml:"expression"`
// The search filter explresison type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.html#cfn-datazone-datasource-filterexpression-type
//
Type *string `field:"required" json:"type" yaml:"type"`
}
A filter expression in Amazon DataZone.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
filterExpressionProperty := &FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
}
type CfnDataSource_FormInputProperty ¶
type CfnDataSource_FormInputProperty struct {
// The name of the metadata form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-formname
//
FormName *string `field:"required" json:"formName" yaml:"formName"`
// The content of the metadata form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-content
//
Content *string `field:"optional" json:"content" yaml:"content"`
// The ID of the metadata form type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-typeidentifier
//
TypeIdentifier *string `field:"optional" json:"typeIdentifier" yaml:"typeIdentifier"`
// The revision of the metadata form type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-typerevision
//
TypeRevision *string `field:"optional" json:"typeRevision" yaml:"typeRevision"`
}
The details of a metadata form.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
formInputProperty := &FormInputProperty{
FormName: jsii.String("formName"),
// the properties below are optional
Content: jsii.String("content"),
TypeIdentifier: jsii.String("typeIdentifier"),
TypeRevision: jsii.String("typeRevision"),
}
type CfnDataSource_GlueRunConfigurationInputProperty ¶
type CfnDataSource_GlueRunConfigurationInputProperty struct {
// The relational filter configurations included in the configuration details of the AWS Glue data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-relationalfilterconfigurations
//
RelationalFilterConfigurations interface{} `field:"required" json:"relationalFilterConfigurations" yaml:"relationalFilterConfigurations"`
// Specifies whether to automatically import data quality metrics as part of the data source run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-autoimportdataqualityresult
//
AutoImportDataQualityResult interface{} `field:"optional" json:"autoImportDataQualityResult" yaml:"autoImportDataQualityResult"`
// The catalog name in the AWS Glue run configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-catalogname
//
CatalogName *string `field:"optional" json:"catalogName" yaml:"catalogName"`
// The data access role included in the configuration details of the AWS Glue data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-dataaccessrole
//
DataAccessRole *string `field:"optional" json:"dataAccessRole" yaml:"dataAccessRole"`
}
The configuration details of the AWS Glue data source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
glueRunConfigurationInputProperty := &GlueRunConfigurationInputProperty{
RelationalFilterConfigurations: []interface{}{
&RelationalFilterConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
// the properties below are optional
FilterExpressions: []interface{}{
&FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
SchemaName: jsii.String("schemaName"),
},
},
// the properties below are optional
AutoImportDataQualityResult: jsii.Boolean(false),
CatalogName: jsii.String("catalogName"),
DataAccessRole: jsii.String("dataAccessRole"),
}
type CfnDataSource_RecommendationConfigurationProperty ¶
type CfnDataSource_RecommendationConfigurationProperty struct {
// Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-recommendationconfiguration.html#cfn-datazone-datasource-recommendationconfiguration-enablebusinessnamegeneration
//
EnableBusinessNameGeneration interface{} `field:"optional" json:"enableBusinessNameGeneration" yaml:"enableBusinessNameGeneration"`
}
The recommendation configuration for the data source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
recommendationConfigurationProperty := &RecommendationConfigurationProperty{
EnableBusinessNameGeneration: jsii.Boolean(false),
}
type CfnDataSource_RedshiftClusterStorageProperty ¶
type CfnDataSource_RedshiftClusterStorageProperty struct {
// The name of an Amazon Redshift cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftclusterstorage.html#cfn-datazone-datasource-redshiftclusterstorage-clustername
//
ClusterName *string `field:"required" json:"clusterName" yaml:"clusterName"`
}
The details of the Amazon Redshift cluster storage.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
redshiftClusterStorageProperty := &RedshiftClusterStorageProperty{
ClusterName: jsii.String("clusterName"),
}
type CfnDataSource_RedshiftCredentialConfigurationProperty ¶
type CfnDataSource_RedshiftCredentialConfigurationProperty struct {
// The ARN of a secret manager for an Amazon Redshift cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftcredentialconfiguration.html#cfn-datazone-datasource-redshiftcredentialconfiguration-secretmanagerarn
//
SecretManagerArn *string `field:"required" json:"secretManagerArn" yaml:"secretManagerArn"`
}
The details of the credentials required to access an Amazon Redshift cluster.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
redshiftCredentialConfigurationProperty := &RedshiftCredentialConfigurationProperty{
SecretManagerArn: jsii.String("secretManagerArn"),
}
type CfnDataSource_RedshiftRunConfigurationInputProperty ¶
type CfnDataSource_RedshiftRunConfigurationInputProperty struct {
// The relational filter configurations included in the configuration details of the AWS Glue data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-relationalfilterconfigurations
//
RelationalFilterConfigurations interface{} `field:"required" json:"relationalFilterConfigurations" yaml:"relationalFilterConfigurations"`
// The data access role included in the configuration details of the Amazon Redshift data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-dataaccessrole
//
DataAccessRole *string `field:"optional" json:"dataAccessRole" yaml:"dataAccessRole"`
// The details of the credentials required to access an Amazon Redshift cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftcredentialconfiguration
//
RedshiftCredentialConfiguration interface{} `field:"optional" json:"redshiftCredentialConfiguration" yaml:"redshiftCredentialConfiguration"`
// The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftstorage
//
RedshiftStorage interface{} `field:"optional" json:"redshiftStorage" yaml:"redshiftStorage"`
}
The relational filter configurations included in the configuration details of the Amazon Redshift data source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
redshiftRunConfigurationInputProperty := &RedshiftRunConfigurationInputProperty{
RelationalFilterConfigurations: []interface{}{
&RelationalFilterConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
// the properties below are optional
FilterExpressions: []interface{}{
&FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
SchemaName: jsii.String("schemaName"),
},
},
// the properties below are optional
DataAccessRole: jsii.String("dataAccessRole"),
RedshiftCredentialConfiguration: &RedshiftCredentialConfigurationProperty{
SecretManagerArn: jsii.String("secretManagerArn"),
},
RedshiftStorage: &RedshiftStorageProperty{
RedshiftClusterSource: &RedshiftClusterStorageProperty{
ClusterName: jsii.String("clusterName"),
},
RedshiftServerlessSource: &RedshiftServerlessStorageProperty{
WorkgroupName: jsii.String("workgroupName"),
},
},
}
type CfnDataSource_RedshiftServerlessStorageProperty ¶
type CfnDataSource_RedshiftServerlessStorageProperty struct {
// The name of the Amazon Redshift Serverless workgroup.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftserverlessstorage.html#cfn-datazone-datasource-redshiftserverlessstorage-workgroupname
//
WorkgroupName *string `field:"required" json:"workgroupName" yaml:"workgroupName"`
}
The details of the Amazon Redshift Serverless workgroup storage.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
redshiftServerlessStorageProperty := &RedshiftServerlessStorageProperty{
WorkgroupName: jsii.String("workgroupName"),
}
type CfnDataSource_RedshiftStorageProperty ¶
type CfnDataSource_RedshiftStorageProperty struct {
// The details of the Amazon Redshift cluster source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.html#cfn-datazone-datasource-redshiftstorage-redshiftclustersource
//
RedshiftClusterSource interface{} `field:"optional" json:"redshiftClusterSource" yaml:"redshiftClusterSource"`
// The details of the Amazon Redshift Serverless workgroup source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.html#cfn-datazone-datasource-redshiftstorage-redshiftserverlesssource
//
RedshiftServerlessSource interface{} `field:"optional" json:"redshiftServerlessSource" yaml:"redshiftServerlessSource"`
}
The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
redshiftStorageProperty := &RedshiftStorageProperty{
RedshiftClusterSource: &RedshiftClusterStorageProperty{
ClusterName: jsii.String("clusterName"),
},
RedshiftServerlessSource: &RedshiftServerlessStorageProperty{
WorkgroupName: jsii.String("workgroupName"),
},
}
type CfnDataSource_RelationalFilterConfigurationProperty ¶
type CfnDataSource_RelationalFilterConfigurationProperty struct {
// The database name specified in the relational filter configuration for the data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-databasename
//
DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"`
// The filter expressions specified in the relational filter configuration for the data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-filterexpressions
//
FilterExpressions interface{} `field:"optional" json:"filterExpressions" yaml:"filterExpressions"`
// The schema name specified in the relational filter configuration for the data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-schemaname
//
SchemaName *string `field:"optional" json:"schemaName" yaml:"schemaName"`
}
The relational filter configuration for the data source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
relationalFilterConfigurationProperty := &RelationalFilterConfigurationProperty{
DatabaseName: jsii.String("databaseName"),
// the properties below are optional
FilterExpressions: []interface{}{
&FilterExpressionProperty{
Expression: jsii.String("expression"),
Type: jsii.String("type"),
},
},
SchemaName: jsii.String("schemaName"),
}
type CfnDataSource_SageMakerRunConfigurationInputProperty ¶ added in v2.174.1
type CfnDataSource_SageMakerRunConfigurationInputProperty struct {
// The tracking assets of the Amazon SageMaker run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-sagemakerrunconfigurationinput.html#cfn-datazone-datasource-sagemakerrunconfigurationinput-trackingassets
//
TrackingAssets interface{} `field:"required" json:"trackingAssets" yaml:"trackingAssets"`
}
The configuration details of the Amazon SageMaker data source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sageMakerRunConfigurationInputProperty := &SageMakerRunConfigurationInputProperty{
TrackingAssets: map[string][]*string{
"trackingAssetsKey": []*string{
jsii.String("trackingAssets"),
},
},
}
type CfnDataSource_ScheduleConfigurationProperty ¶
type CfnDataSource_ScheduleConfigurationProperty struct {
// The schedule of the data source runs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.html#cfn-datazone-datasource-scheduleconfiguration-schedule
//
Schedule *string `field:"optional" json:"schedule" yaml:"schedule"`
// The timezone of the data source run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.html#cfn-datazone-datasource-scheduleconfiguration-timezone
//
Timezone *string `field:"optional" json:"timezone" yaml:"timezone"`
}
The details of the schedule of the data source runs.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
scheduleConfigurationProperty := &ScheduleConfigurationProperty{
Schedule: jsii.String("schedule"),
Timezone: jsii.String("timezone"),
}
type CfnDomain ¶
type CfnDomain interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IDomainRef
awscdk.ITaggableV2
// The ARN of the Amazon DataZone domain.
AttrArn() *string
// A timestamp of when a Amazon DataZone domain was created.
AttrCreatedAt() *string
// The ID of the Amazon DataZone domain.
AttrId() *string
// A timestamp of when a Amazon DataZone domain was last updated.
AttrLastUpdatedAt() *string
// The identifier of the AWS account that manages the domain.
AttrManagedAccountId() *string
// The data portal URL for the Amazon DataZone domain.
AttrPortalUrl() *string
// The ID of the root domain unit.
AttrRootDomainUnitId() *string
// The status of the Amazon DataZone domain.
AttrStatus() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The description of the Amazon DataZone domain.
Description() *string
SetDescription(val *string)
// The domain execution role that is created when an Amazon DataZone domain is created.
DomainExecutionRole() *string
SetDomainExecutionRole(val *string)
// A reference to a Domain resource.
DomainRef() *interfacesawsdatazone.DomainReference
// The domain version.
DomainVersion() *string
SetDomainVersion(val *string)
Env() *interfaces.ResourceEnvironment
// The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
KmsKeyIdentifier() *string
SetKmsKeyIdentifier(val *string)
// 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 name of the Amazon DataZone domain.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 service role of the domain.
ServiceRole() *string
SetServiceRole(val *string)
// The single sign-on details in Amazon DataZone.
SingleSignOn() interface{}
SetSingleSignOn(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags specified for the Amazon DataZone domain.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The `AWS::DataZone::Domain` resource specifies an Amazon DataZone domain.
You can use domains to organize your assets, users, and their projects.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDomain := awscdk.Aws_datazone.NewCfnDomain(this, jsii.String("MyCfnDomain"), &CfnDomainProps{
DomainExecutionRole: jsii.String("domainExecutionRole"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
DomainVersion: jsii.String("domainVersion"),
KmsKeyIdentifier: jsii.String("kmsKeyIdentifier"),
ServiceRole: jsii.String("serviceRole"),
SingleSignOn: &SingleSignOnProperty{
IdcInstanceArn: jsii.String("idcInstanceArn"),
Type: jsii.String("type"),
UserAssignment: jsii.String("userAssignment"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html
func NewCfnDomain ¶
func NewCfnDomain(scope constructs.Construct, id *string, props *CfnDomainProps) CfnDomain
Create a new `AWS::DataZone::Domain`.
type CfnDomainProps ¶
type CfnDomainProps struct {
// The domain execution role that is created when an Amazon DataZone domain is created.
//
// The domain execution role is created in the AWS account that houses the Amazon DataZone domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-domainexecutionrole
//
DomainExecutionRole *string `field:"required" json:"domainExecutionRole" yaml:"domainExecutionRole"`
// The name of the Amazon DataZone domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The description of the Amazon DataZone domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The domain version.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-domainversion
//
DomainVersion *string `field:"optional" json:"domainVersion" yaml:"domainVersion"`
// The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-kmskeyidentifier
//
KmsKeyIdentifier *string `field:"optional" json:"kmsKeyIdentifier" yaml:"kmsKeyIdentifier"`
// The service role of the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-servicerole
//
ServiceRole *string `field:"optional" json:"serviceRole" yaml:"serviceRole"`
// The single sign-on details in Amazon DataZone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-singlesignon
//
SingleSignOn interface{} `field:"optional" json:"singleSignOn" yaml:"singleSignOn"`
// The tags specified for the Amazon DataZone domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDomain`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDomainProps := &CfnDomainProps{
DomainExecutionRole: jsii.String("domainExecutionRole"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
DomainVersion: jsii.String("domainVersion"),
KmsKeyIdentifier: jsii.String("kmsKeyIdentifier"),
ServiceRole: jsii.String("serviceRole"),
SingleSignOn: &SingleSignOnProperty{
IdcInstanceArn: jsii.String("idcInstanceArn"),
Type: jsii.String("type"),
UserAssignment: jsii.String("userAssignment"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html
type CfnDomainUnit ¶ added in v2.195.0
type CfnDomainUnit interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IDomainUnitRef
// The time stamp at which the domain unit was created.
AttrCreatedAt() *string
// The ID of the domain in which the domain unit lives.
AttrDomainId() *string
// The ID of the domain unit.
AttrId() *string
// The identifier of the domain unit that you want to get.
AttrIdentifier() *string
// The timestamp at which the domain unit was last updated.
AttrLastUpdatedAt() *string
// The ID of the parent domain unit.
AttrParentDomainUnitId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The description of the domain unit.
Description() *string
SetDescription(val *string)
// The ID of the domain where you want to crate a domain unit.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
// A reference to a DomainUnit resource.
DomainUnitRef() *interfacesawsdatazone.DomainUnitReference
Env() *interfaces.ResourceEnvironment
// 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 name of the domain unit.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The ID of the parent domain unit.
ParentDomainUnitIdentifier() *string
SetParentDomainUnitIdentifier(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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The summary of the domain unit.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDomainUnit := awscdk.Aws_datazone.NewCfnDomainUnit(this, jsii.String("MyCfnDomainUnit"), &CfnDomainUnitProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
ParentDomainUnitIdentifier: jsii.String("parentDomainUnitIdentifier"),
// the properties below are optional
Description: jsii.String("description"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html
func NewCfnDomainUnit ¶ added in v2.195.0
func NewCfnDomainUnit(scope constructs.Construct, id *string, props *CfnDomainUnitProps) CfnDomainUnit
Create a new `AWS::DataZone::DomainUnit`.
type CfnDomainUnitProps ¶ added in v2.195.0
type CfnDomainUnitProps struct {
// The ID of the domain where you want to crate a domain unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#cfn-datazone-domainunit-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The name of the domain unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#cfn-datazone-domainunit-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The ID of the parent domain unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#cfn-datazone-domainunit-parentdomainunitidentifier
//
ParentDomainUnitIdentifier *string `field:"required" json:"parentDomainUnitIdentifier" yaml:"parentDomainUnitIdentifier"`
// The description of the domain unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html#cfn-datazone-domainunit-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
}
Properties for defining a `CfnDomainUnit`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDomainUnitProps := &CfnDomainUnitProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
ParentDomainUnitIdentifier: jsii.String("parentDomainUnitIdentifier"),
// the properties below are optional
Description: jsii.String("description"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domainunit.html
type CfnDomain_SingleSignOnProperty ¶
type CfnDomain_SingleSignOnProperty struct {
// The ARN of the IDC instance.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-domain-singlesignon.html#cfn-datazone-domain-singlesignon-idcinstancearn
//
IdcInstanceArn *string `field:"optional" json:"idcInstanceArn" yaml:"idcInstanceArn"`
// The type of single sign-on in Amazon DataZone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-domain-singlesignon.html#cfn-datazone-domain-singlesignon-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The single sign-on user assignment in Amazon DataZone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-domain-singlesignon.html#cfn-datazone-domain-singlesignon-userassignment
//
UserAssignment *string `field:"optional" json:"userAssignment" yaml:"userAssignment"`
}
The single sign-on details in Amazon DataZone.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
singleSignOnProperty := &SingleSignOnProperty{
IdcInstanceArn: jsii.String("idcInstanceArn"),
Type: jsii.String("type"),
UserAssignment: jsii.String("userAssignment"),
}
type CfnEnvironment ¶
type CfnEnvironment interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IEnvironmentRef
// The identifier of the AWS account in which an environment exists.
AttrAwsAccountId() *string
// The AWS Region in which an environment exists.
AttrAwsAccountRegion() *string
// The timestamp of when the environment was created.
AttrCreatedAt() *string
// The Amazon DataZone user who created the environment.
AttrCreatedBy() *string
// The identifier of the Amazon DataZone domain in which the environment exists.
AttrDomainId() *string
// The identifier of a blueprint with which an environment profile is created.
AttrEnvironmentBlueprintId() *string
// The identifier of the environment profile with which the environment was created.
AttrEnvironmentProfileId() *string
// The identifier of the environment.
AttrId() *string
// The identifier of the project in which the environment exists.
AttrProjectId() *string
// The provider of the environment.
AttrProvider() *string
// The status of the environment.
AttrStatus() *string
// The timestamp of when the environment was updated.
AttrUpdatedAt() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The description of the environment.
Description() *string
SetDescription(val *string)
// The identifier of the Amazon DataZone domain in which the environment is created.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
Env() *interfaces.ResourceEnvironment
// The identifier of the AWS account in which an environment exists.
EnvironmentAccountIdentifier() *string
SetEnvironmentAccountIdentifier(val *string)
// The AWS Region in which an environment exists.
EnvironmentAccountRegion() *string
SetEnvironmentAccountRegion(val *string)
// The identifier of the environment profile that is used to create this Amazon DataZone environment.
EnvironmentProfileIdentifier() *string
SetEnvironmentProfileIdentifier(val *string)
// A reference to a Environment resource.
EnvironmentRef() *interfacesawsdatazone.EnvironmentReference
// The ARN of the environment role.
EnvironmentRoleArn() *string
SetEnvironmentRoleArn(val *string)
// The glossary terms that can be used in this Amazon DataZone environment.
GlossaryTerms() *[]*string
SetGlossaryTerms(val *[]*string)
// 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 name of the Amazon DataZone environment.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The identifier of the Amazon DataZone project in which this environment is created.
ProjectIdentifier() *string
SetProjectIdentifier(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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The user parameters of this Amazon DataZone environment.
UserParameters() interface{}
SetUserParameters(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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The `AWS::DataZone::Environment` resource specifies an Amazon DataZone environment, which is a collection of zero or more configured resources with a given set of IAM principals who can operate on those resources.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironment := awscdk.Aws_datazone.NewCfnEnvironment(this, jsii.String("MyCfnEnvironment"), &CfnEnvironmentProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
ProjectIdentifier: jsii.String("projectIdentifier"),
// the properties below are optional
Description: jsii.String("description"),
EnvironmentAccountIdentifier: jsii.String("environmentAccountIdentifier"),
EnvironmentAccountRegion: jsii.String("environmentAccountRegion"),
EnvironmentProfileIdentifier: jsii.String("environmentProfileIdentifier"),
EnvironmentRoleArn: jsii.String("environmentRoleArn"),
GlossaryTerms: []*string{
jsii.String("glossaryTerms"),
},
UserParameters: []interface{}{
&EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html
func NewCfnEnvironment ¶
func NewCfnEnvironment(scope constructs.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment
Create a new `AWS::DataZone::Environment`.
type CfnEnvironmentActions ¶ added in v2.159.0
type CfnEnvironmentActions interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IEnvironmentActionsRef
// The Amazon DataZone domain ID of the environment action.
AttrDomainId() *string
// The environment ID of the environment action.
AttrEnvironmentId() *string
// The ID of the environment action.
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The environment action description.
Description() *string
SetDescription(val *string)
// The Amazon DataZone domain ID of the environment action.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
Env() *interfaces.ResourceEnvironment
// A reference to a EnvironmentActions resource.
EnvironmentActionsRef() *interfacesawsdatazone.EnvironmentActionsReference
// The environment ID of the environment action.
EnvironmentIdentifier() *string
SetEnvironmentIdentifier(val *string)
// The ID of the environment action.
Identifier() *string
SetIdentifier(val *string)
// 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 name of the environment action.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The parameters of the environment action.
Parameters() interface{}
SetParameters(val interface{})
// 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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The details about the specified action configured for an environment.
For example, the details of the specified console links for an analytics tool that is available in this environment.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironmentActions := awscdk.Aws_datazone.NewCfnEnvironmentActions(this, jsii.String("MyCfnEnvironmentActions"), &CfnEnvironmentActionsProps{
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
DomainIdentifier: jsii.String("domainIdentifier"),
EnvironmentIdentifier: jsii.String("environmentIdentifier"),
Identifier: jsii.String("identifier"),
Parameters: &AwsConsoleLinkParametersProperty{
Uri: jsii.String("uri"),
},
})
func NewCfnEnvironmentActions ¶ added in v2.159.0
func NewCfnEnvironmentActions(scope constructs.Construct, id *string, props *CfnEnvironmentActionsProps) CfnEnvironmentActions
Create a new `AWS::DataZone::EnvironmentActions`.
type CfnEnvironmentActionsProps ¶ added in v2.159.0
type CfnEnvironmentActionsProps struct {
// The name of the environment action.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The environment action description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The Amazon DataZone domain ID of the environment action.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-domainidentifier
//
DomainIdentifier *string `field:"optional" json:"domainIdentifier" yaml:"domainIdentifier"`
// The environment ID of the environment action.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-environmentidentifier
//
EnvironmentIdentifier *string `field:"optional" json:"environmentIdentifier" yaml:"environmentIdentifier"`
// The ID of the environment action.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-identifier
//
Identifier *string `field:"optional" json:"identifier" yaml:"identifier"`
// The parameters of the environment action.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentactions.html#cfn-datazone-environmentactions-parameters
//
Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
}
Properties for defining a `CfnEnvironmentActions`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironmentActionsProps := &CfnEnvironmentActionsProps{
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
DomainIdentifier: jsii.String("domainIdentifier"),
EnvironmentIdentifier: jsii.String("environmentIdentifier"),
Identifier: jsii.String("identifier"),
Parameters: &AwsConsoleLinkParametersProperty{
Uri: jsii.String("uri"),
},
}
type CfnEnvironmentActions_AwsConsoleLinkParametersProperty ¶ added in v2.159.0
type CfnEnvironmentActions_AwsConsoleLinkParametersProperty struct {
// The URI of the console link specified as part of the environment action.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentactions-awsconsolelinkparameters.html#cfn-datazone-environmentactions-awsconsolelinkparameters-uri
//
Uri *string `field:"optional" json:"uri" yaml:"uri"`
}
The parameters of the console link specified as part of the environment action.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
awsConsoleLinkParametersProperty := &AwsConsoleLinkParametersProperty{
Uri: jsii.String("uri"),
}
type CfnEnvironmentBlueprintConfiguration ¶
type CfnEnvironmentBlueprintConfiguration interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IEnvironmentBlueprintConfigurationRef
// The timestamp of when an environment blueprint was created.
AttrCreatedAt() *string
// The identifier of the Amazon DataZone domain in which an environment blueprint exists.
AttrDomainId() *string
// The identifier of the environment blueprint.
//
// This identifier should be used when creating environment profiles.
AttrEnvironmentBlueprintId() *string
// The timestamp of when the environment blueprint was updated.
AttrUpdatedAt() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The identifier of the Amazon DataZone domain in which an environment blueprint exists.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
// The enabled AWS Regions specified in a blueprint configuration.
EnabledRegions() *[]*string
SetEnabledRegions(val *[]*string)
Env() *interfaces.ResourceEnvironment
// A reference to a EnvironmentBlueprintConfiguration resource.
EnvironmentBlueprintConfigurationRef() *interfacesawsdatazone.EnvironmentBlueprintConfigurationReference
// The identifier of the environment blueprint.
EnvironmentBlueprintIdentifier() *string
SetEnvironmentBlueprintIdentifier(val *string)
// The environment role permission boundary.
EnvironmentRolePermissionBoundary() *string
SetEnvironmentRolePermissionBoundary(val *string)
// 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 ARN of the manage access role.
ManageAccessRoleArn() *string
SetManageAccessRoleArn(val *string)
// The tree node.
Node() constructs.Node
// The provisioning configuration of a blueprint.
ProvisioningConfigurations() interface{}
SetProvisioningConfigurations(val interface{})
// The ARN of the provisioning role.
ProvisioningRoleArn() *string
SetProvisioningRoleArn(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 regional parameters of the environment blueprint.
RegionalParameters() interface{}
SetRegionalParameters(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The configuration details of an environment blueprint.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironmentBlueprintConfiguration := awscdk.Aws_datazone.NewCfnEnvironmentBlueprintConfiguration(this, jsii.String("MyCfnEnvironmentBlueprintConfiguration"), &CfnEnvironmentBlueprintConfigurationProps{
DomainIdentifier: jsii.String("domainIdentifier"),
EnabledRegions: []*string{
jsii.String("enabledRegions"),
},
EnvironmentBlueprintIdentifier: jsii.String("environmentBlueprintIdentifier"),
// the properties below are optional
EnvironmentRolePermissionBoundary: jsii.String("environmentRolePermissionBoundary"),
ManageAccessRoleArn: jsii.String("manageAccessRoleArn"),
ProvisioningConfigurations: []interface{}{
&ProvisioningConfigurationProperty{
LakeFormationConfiguration: &LakeFormationConfigurationProperty{
LocationRegistrationExcludeS3Locations: []*string{
jsii.String("locationRegistrationExcludeS3Locations"),
},
LocationRegistrationRole: jsii.String("locationRegistrationRole"),
},
},
},
ProvisioningRoleArn: jsii.String("provisioningRoleArn"),
RegionalParameters: []interface{}{
&RegionalParameterProperty{
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
Region: jsii.String("region"),
},
},
})
func NewCfnEnvironmentBlueprintConfiguration ¶
func NewCfnEnvironmentBlueprintConfiguration(scope constructs.Construct, id *string, props *CfnEnvironmentBlueprintConfigurationProps) CfnEnvironmentBlueprintConfiguration
Create a new `AWS::DataZone::EnvironmentBlueprintConfiguration`.
type CfnEnvironmentBlueprintConfigurationProps ¶
type CfnEnvironmentBlueprintConfigurationProps struct {
// The identifier of the Amazon DataZone domain in which an environment blueprint exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The enabled AWS Regions specified in a blueprint configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-enabledregions
//
EnabledRegions *[]*string `field:"required" json:"enabledRegions" yaml:"enabledRegions"`
// The identifier of the environment blueprint.
//
// In the current release, only the following values are supported: `DefaultDataLake` and `DefaultDataWarehouse` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-environmentblueprintidentifier
//
EnvironmentBlueprintIdentifier *string `field:"required" json:"environmentBlueprintIdentifier" yaml:"environmentBlueprintIdentifier"`
// The environment role permission boundary.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-environmentrolepermissionboundary
//
EnvironmentRolePermissionBoundary *string `field:"optional" json:"environmentRolePermissionBoundary" yaml:"environmentRolePermissionBoundary"`
// The ARN of the manage access role.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-manageaccessrolearn
//
ManageAccessRoleArn *string `field:"optional" json:"manageAccessRoleArn" yaml:"manageAccessRoleArn"`
// The provisioning configuration of a blueprint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-provisioningconfigurations
//
ProvisioningConfigurations interface{} `field:"optional" json:"provisioningConfigurations" yaml:"provisioningConfigurations"`
// The ARN of the provisioning role.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-provisioningrolearn
//
ProvisioningRoleArn *string `field:"optional" json:"provisioningRoleArn" yaml:"provisioningRoleArn"`
// The regional parameters of the environment blueprint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-regionalparameters
//
RegionalParameters interface{} `field:"optional" json:"regionalParameters" yaml:"regionalParameters"`
}
Properties for defining a `CfnEnvironmentBlueprintConfiguration`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironmentBlueprintConfigurationProps := &CfnEnvironmentBlueprintConfigurationProps{
DomainIdentifier: jsii.String("domainIdentifier"),
EnabledRegions: []*string{
jsii.String("enabledRegions"),
},
EnvironmentBlueprintIdentifier: jsii.String("environmentBlueprintIdentifier"),
// the properties below are optional
EnvironmentRolePermissionBoundary: jsii.String("environmentRolePermissionBoundary"),
ManageAccessRoleArn: jsii.String("manageAccessRoleArn"),
ProvisioningConfigurations: []interface{}{
&ProvisioningConfigurationProperty{
LakeFormationConfiguration: &LakeFormationConfigurationProperty{
LocationRegistrationExcludeS3Locations: []*string{
jsii.String("locationRegistrationExcludeS3Locations"),
},
LocationRegistrationRole: jsii.String("locationRegistrationRole"),
},
},
},
ProvisioningRoleArn: jsii.String("provisioningRoleArn"),
RegionalParameters: []interface{}{
&RegionalParameterProperty{
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
Region: jsii.String("region"),
},
},
}
type CfnEnvironmentBlueprintConfiguration_LakeFormationConfigurationProperty ¶ added in v2.197.0
type CfnEnvironmentBlueprintConfiguration_LakeFormationConfigurationProperty struct {
// Specifies certain Amazon S3 locations if you do not want Amazon DataZone to automatically register them in hybrid mode.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-lakeformationconfiguration.html#cfn-datazone-environmentblueprintconfiguration-lakeformationconfiguration-locationregistrationexcludes3locations
//
LocationRegistrationExcludeS3Locations *[]*string `field:"optional" json:"locationRegistrationExcludeS3Locations" yaml:"locationRegistrationExcludeS3Locations"`
// The role that is used to manage read/write access to the chosen Amazon S3 bucket(s) for Data Lake using AWS Lake Formation hybrid access mode.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-lakeformationconfiguration.html#cfn-datazone-environmentblueprintconfiguration-lakeformationconfiguration-locationregistrationrole
//
LocationRegistrationRole *string `field:"optional" json:"locationRegistrationRole" yaml:"locationRegistrationRole"`
}
The Lake Formation configuration of the Data Lake blueprint.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
lakeFormationConfigurationProperty := &LakeFormationConfigurationProperty{
LocationRegistrationExcludeS3Locations: []*string{
jsii.String("locationRegistrationExcludeS3Locations"),
},
LocationRegistrationRole: jsii.String("locationRegistrationRole"),
}
type CfnEnvironmentBlueprintConfiguration_ProvisioningConfigurationProperty ¶ added in v2.197.0
type CfnEnvironmentBlueprintConfiguration_ProvisioningConfigurationProperty struct {
// The Lake Formation configuration of the Data Lake blueprint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-provisioningconfiguration.html#cfn-datazone-environmentblueprintconfiguration-provisioningconfiguration-lakeformationconfiguration
//
LakeFormationConfiguration interface{} `field:"required" json:"lakeFormationConfiguration" yaml:"lakeFormationConfiguration"`
}
The provisioning configuration of the blueprint.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
provisioningConfigurationProperty := &ProvisioningConfigurationProperty{
LakeFormationConfiguration: &LakeFormationConfigurationProperty{
LocationRegistrationExcludeS3Locations: []*string{
jsii.String("locationRegistrationExcludeS3Locations"),
},
LocationRegistrationRole: jsii.String("locationRegistrationRole"),
},
}
type CfnEnvironmentBlueprintConfiguration_RegionalParameterProperty ¶
type CfnEnvironmentBlueprintConfiguration_RegionalParameterProperty struct {
// A string to string map containing parameters for the region.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-regionalparameter.html#cfn-datazone-environmentblueprintconfiguration-regionalparameter-parameters
//
Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
// The region specified in the environment parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-regionalparameter.html#cfn-datazone-environmentblueprintconfiguration-regionalparameter-region
//
Region *string `field:"optional" json:"region" yaml:"region"`
}
The regional parameters in the environment blueprint.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
regionalParameterProperty := &RegionalParameterProperty{
Parameters: map[string]*string{
"parametersKey": jsii.String("parameters"),
},
Region: jsii.String("region"),
}
type CfnEnvironmentProfile ¶
type CfnEnvironmentProfile interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IEnvironmentProfileRef
// The timestamp of when an environment profile was created.
AttrCreatedAt() *string
// The Amazon DataZone user who created the environment profile.
AttrCreatedBy() *string
// The identifier of the Amazon DataZone domain in which the environment profile exists.
AttrDomainId() *string
// The identifier of a blueprint with which an environment profile is created.
AttrEnvironmentBlueprintId() *string
// The identifier of the environment profile.
AttrId() *string
// The identifier of a project in which an environment profile exists.
AttrProjectId() *string
// The timestamp of when the environment profile was updated.
AttrUpdatedAt() *string
// The identifier of an AWS account in which an environment profile exists.
AwsAccountId() *string
SetAwsAccountId(val *string)
// The AWS Region in which an environment profile exists.
AwsAccountRegion() *string
SetAwsAccountRegion(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The description of the environment profile.
Description() *string
SetDescription(val *string)
// The identifier of the Amazon DataZone domain in which the environment profile exists.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
Env() *interfaces.ResourceEnvironment
// The identifier of a blueprint with which an environment profile is created.
EnvironmentBlueprintIdentifier() *string
SetEnvironmentBlueprintIdentifier(val *string)
// A reference to a EnvironmentProfile resource.
EnvironmentProfileRef() *interfacesawsdatazone.EnvironmentProfileReference
// 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 name of the environment profile.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The identifier of a project in which an environment profile exists.
ProjectIdentifier() *string
SetProjectIdentifier(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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The user parameters of this Amazon DataZone environment profile.
UserParameters() interface{}
SetUserParameters(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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The details of an environment profile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironmentProfile := awscdk.Aws_datazone.NewCfnEnvironmentProfile(this, jsii.String("MyCfnEnvironmentProfile"), &CfnEnvironmentProfileProps{
AwsAccountId: jsii.String("awsAccountId"),
AwsAccountRegion: jsii.String("awsAccountRegion"),
DomainIdentifier: jsii.String("domainIdentifier"),
EnvironmentBlueprintIdentifier: jsii.String("environmentBlueprintIdentifier"),
Name: jsii.String("name"),
ProjectIdentifier: jsii.String("projectIdentifier"),
// the properties below are optional
Description: jsii.String("description"),
UserParameters: []interface{}{
&EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
})
func NewCfnEnvironmentProfile ¶
func NewCfnEnvironmentProfile(scope constructs.Construct, id *string, props *CfnEnvironmentProfileProps) CfnEnvironmentProfile
Create a new `AWS::DataZone::EnvironmentProfile`.
type CfnEnvironmentProfileProps ¶
type CfnEnvironmentProfileProps struct {
// The identifier of an AWS account in which an environment profile exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-awsaccountid
//
AwsAccountId *string `field:"required" json:"awsAccountId" yaml:"awsAccountId"`
// The AWS Region in which an environment profile exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-awsaccountregion
//
AwsAccountRegion *string `field:"required" json:"awsAccountRegion" yaml:"awsAccountRegion"`
// The identifier of the Amazon DataZone domain in which the environment profile exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The identifier of a blueprint with which an environment profile is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-environmentblueprintidentifier
//
EnvironmentBlueprintIdentifier *string `field:"required" json:"environmentBlueprintIdentifier" yaml:"environmentBlueprintIdentifier"`
// The name of the environment profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The identifier of a project in which an environment profile exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-projectidentifier
//
ProjectIdentifier *string `field:"required" json:"projectIdentifier" yaml:"projectIdentifier"`
// The description of the environment profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The user parameters of this Amazon DataZone environment profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-userparameters
//
UserParameters interface{} `field:"optional" json:"userParameters" yaml:"userParameters"`
}
Properties for defining a `CfnEnvironmentProfile`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironmentProfileProps := &CfnEnvironmentProfileProps{
AwsAccountId: jsii.String("awsAccountId"),
AwsAccountRegion: jsii.String("awsAccountRegion"),
DomainIdentifier: jsii.String("domainIdentifier"),
EnvironmentBlueprintIdentifier: jsii.String("environmentBlueprintIdentifier"),
Name: jsii.String("name"),
ProjectIdentifier: jsii.String("projectIdentifier"),
// the properties below are optional
Description: jsii.String("description"),
UserParameters: []interface{}{
&EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
}
type CfnEnvironmentProfile_EnvironmentParameterProperty ¶
type CfnEnvironmentProfile_EnvironmentParameterProperty struct {
// The name specified in the environment parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentprofile-environmentparameter.html#cfn-datazone-environmentprofile-environmentparameter-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The value of the environment profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentprofile-environmentparameter.html#cfn-datazone-environmentprofile-environmentparameter-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
The parameter details of an environment profile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
environmentParameterProperty := &EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
}
type CfnEnvironmentProps ¶
type CfnEnvironmentProps struct {
// The identifier of the Amazon DataZone domain in which the environment is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The name of the Amazon DataZone environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The identifier of the Amazon DataZone project in which this environment is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-projectidentifier
//
ProjectIdentifier *string `field:"required" json:"projectIdentifier" yaml:"projectIdentifier"`
// The description of the environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The identifier of the AWS account in which an environment exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentaccountidentifier
//
EnvironmentAccountIdentifier *string `field:"optional" json:"environmentAccountIdentifier" yaml:"environmentAccountIdentifier"`
// The AWS Region in which an environment exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentaccountregion
//
EnvironmentAccountRegion *string `field:"optional" json:"environmentAccountRegion" yaml:"environmentAccountRegion"`
// The identifier of the environment profile that is used to create this Amazon DataZone environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentprofileidentifier
//
EnvironmentProfileIdentifier *string `field:"optional" json:"environmentProfileIdentifier" yaml:"environmentProfileIdentifier"`
// The ARN of the environment role.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentrolearn
//
EnvironmentRoleArn *string `field:"optional" json:"environmentRoleArn" yaml:"environmentRoleArn"`
// The glossary terms that can be used in this Amazon DataZone environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-glossaryterms
//
GlossaryTerms *[]*string `field:"optional" json:"glossaryTerms" yaml:"glossaryTerms"`
// The user parameters of this Amazon DataZone environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-userparameters
//
UserParameters interface{} `field:"optional" json:"userParameters" yaml:"userParameters"`
}
Properties for defining a `CfnEnvironment`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEnvironmentProps := &CfnEnvironmentProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
ProjectIdentifier: jsii.String("projectIdentifier"),
// the properties below are optional
Description: jsii.String("description"),
EnvironmentAccountIdentifier: jsii.String("environmentAccountIdentifier"),
EnvironmentAccountRegion: jsii.String("environmentAccountRegion"),
EnvironmentProfileIdentifier: jsii.String("environmentProfileIdentifier"),
EnvironmentRoleArn: jsii.String("environmentRoleArn"),
GlossaryTerms: []*string{
jsii.String("glossaryTerms"),
},
UserParameters: []interface{}{
&EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html
type CfnEnvironment_EnvironmentParameterProperty ¶
type CfnEnvironment_EnvironmentParameterProperty struct {
// The name of the environment parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environment-environmentparameter.html#cfn-datazone-environment-environmentparameter-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The value of the environment parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environment-environmentparameter.html#cfn-datazone-environment-environmentparameter-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
The parameter details of the environment.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
environmentParameterProperty := &EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
}
type CfnFormType ¶ added in v2.217.0
type CfnFormType interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IFormTypeRef
// The timestamp of when the metadata form type was created.
AttrCreatedAt() *string
// The Amazon DataZone user who created teh metadata form type.
AttrCreatedBy() *string
// The identifier of the Amazon DataZone domain in which the form type exists.
AttrDomainId() *string
// The ID of the metadata form type.
AttrFormTypeIdentifier() *string
// The identifier of the project that owns the form type.
AttrOwningProjectId() *string
// The revision of the form type.
AttrRevision() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The description of the metadata form type.
Description() *string
SetDescription(val *string)
// The identifier of the Amazon DataZone domain in which the form type exists.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
Env() *interfaces.ResourceEnvironment
// A reference to a FormType resource.
FormTypeRef() *interfacesawsdatazone.FormTypeReference
// 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 model of the form type.
Model() interface{}
SetModel(val interface{})
// The name of the form type.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The identifier of the project that owns the form type.
OwningProjectIdentifier() *string
SetOwningProjectIdentifier(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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The status of the form type.
Status() *string
SetStatus(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The details of the metadata form type.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnFormType := awscdk.Aws_datazone.NewCfnFormType(this, jsii.String("MyCfnFormType"), &CfnFormTypeProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Model: &ModelProperty{
Smithy: jsii.String("smithy"),
},
Name: jsii.String("name"),
OwningProjectIdentifier: jsii.String("owningProjectIdentifier"),
// the properties below are optional
Description: jsii.String("description"),
Status: jsii.String("status"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html
func NewCfnFormType ¶ added in v2.217.0
func NewCfnFormType(scope constructs.Construct, id *string, props *CfnFormTypeProps) CfnFormType
Create a new `AWS::DataZone::FormType`.
type CfnFormTypeProps ¶ added in v2.217.0
type CfnFormTypeProps struct {
// The identifier of the Amazon DataZone domain in which the form type exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The model of the form type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-model
//
Model interface{} `field:"required" json:"model" yaml:"model"`
// The name of the form type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The identifier of the project that owns the form type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-owningprojectidentifier
//
OwningProjectIdentifier *string `field:"required" json:"owningProjectIdentifier" yaml:"owningProjectIdentifier"`
// The description of the metadata form type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The status of the form type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html#cfn-datazone-formtype-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
Properties for defining a `CfnFormType`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnFormTypeProps := &CfnFormTypeProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Model: &ModelProperty{
Smithy: jsii.String("smithy"),
},
Name: jsii.String("name"),
OwningProjectIdentifier: jsii.String("owningProjectIdentifier"),
// the properties below are optional
Description: jsii.String("description"),
Status: jsii.String("status"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-formtype.html
type CfnFormType_ModelProperty ¶ added in v2.217.0
type CfnFormType_ModelProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-formtype-model.html#cfn-datazone-formtype-model-smithy
//
Smithy *string `field:"optional" json:"smithy" yaml:"smithy"`
}
Indicates the smithy model of the API.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
modelProperty := &ModelProperty{
Smithy: jsii.String("smithy"),
}
type CfnGroupProfile ¶ added in v2.143.0
type CfnGroupProfile interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IGroupProfileRef
// The identifier of the Amazon DataZone domain in which a group profile exists.
AttrDomainId() *string
// The name of a group profile.
AttrGroupName() *string
// The ID of a group profile.
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The identifier of the Amazon DataZone domain in which a group profile exists.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
Env() *interfaces.ResourceEnvironment
// The ID of the group of a project member.
GroupIdentifier() *string
SetGroupIdentifier(val *string)
// A reference to a GroupProfile resource.
GroupProfileRef() *interfacesawsdatazone.GroupProfileReference
// 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 tree node.
Node() constructs.Node
// 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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The status of a group profile.
Status() *string
SetStatus(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The details of a group profile in Amazon DataZone.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnGroupProfile := awscdk.Aws_datazone.NewCfnGroupProfile(this, jsii.String("MyCfnGroupProfile"), &CfnGroupProfileProps{
DomainIdentifier: jsii.String("domainIdentifier"),
GroupIdentifier: jsii.String("groupIdentifier"),
// the properties below are optional
Status: jsii.String("status"),
})
func NewCfnGroupProfile ¶ added in v2.143.0
func NewCfnGroupProfile(scope constructs.Construct, id *string, props *CfnGroupProfileProps) CfnGroupProfile
Create a new `AWS::DataZone::GroupProfile`.
type CfnGroupProfileProps ¶ added in v2.143.0
type CfnGroupProfileProps struct {
// The identifier of the Amazon DataZone domain in which a group profile exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html#cfn-datazone-groupprofile-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The ID of the group of a project member.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html#cfn-datazone-groupprofile-groupidentifier
//
GroupIdentifier *string `field:"required" json:"groupIdentifier" yaml:"groupIdentifier"`
// The status of a group profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-groupprofile.html#cfn-datazone-groupprofile-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
Properties for defining a `CfnGroupProfile`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnGroupProfileProps := &CfnGroupProfileProps{
DomainIdentifier: jsii.String("domainIdentifier"),
GroupIdentifier: jsii.String("groupIdentifier"),
// the properties below are optional
Status: jsii.String("status"),
}
type CfnOwner ¶ added in v2.196.0
type CfnOwner interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IOwnerRef
// The ID of the entity to which you want to add an owner.
AttrOwnerIdentifier() *string
// The owner that you want to add to the entity.
AttrOwnerType() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The ID of the domain in which you want to add the entity owner.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
// The ID of the entity to which you want to add an owner.
EntityIdentifier() *string
SetEntityIdentifier(val *string)
// The type of an entity.
EntityType() *string
SetEntityType(val *string)
Env() *interfaces.ResourceEnvironment
// 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 tree node.
Node() constructs.Node
// The owner that you want to add to the entity.
Owner() interface{}
SetOwner(val interface{})
// A reference to a Owner resource.
OwnerRef() *interfacesawsdatazone.OwnerReference
// 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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The owner that you want to add to the entity.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnOwner := awscdk.Aws_datazone.NewCfnOwner(this, jsii.String("MyCfnOwner"), &CfnOwnerProps{
DomainIdentifier: jsii.String("domainIdentifier"),
EntityIdentifier: jsii.String("entityIdentifier"),
EntityType: jsii.String("entityType"),
Owner: &OwnerPropertiesProperty{
Group: &OwnerGroupPropertiesProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
},
User: &OwnerUserPropertiesProperty{
UserIdentifier: jsii.String("userIdentifier"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html
func NewCfnOwner ¶ added in v2.196.0
func NewCfnOwner(scope constructs.Construct, id *string, props *CfnOwnerProps) CfnOwner
Create a new `AWS::DataZone::Owner`.
type CfnOwnerProps ¶ added in v2.196.0
type CfnOwnerProps struct {
// The ID of the domain in which you want to add the entity owner.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#cfn-datazone-owner-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The ID of the entity to which you want to add an owner.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#cfn-datazone-owner-entityidentifier
//
EntityIdentifier *string `field:"required" json:"entityIdentifier" yaml:"entityIdentifier"`
// The type of an entity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#cfn-datazone-owner-entitytype
//
EntityType *string `field:"required" json:"entityType" yaml:"entityType"`
// The owner that you want to add to the entity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html#cfn-datazone-owner-owner
//
Owner interface{} `field:"required" json:"owner" yaml:"owner"`
}
Properties for defining a `CfnOwner`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnOwnerProps := &CfnOwnerProps{
DomainIdentifier: jsii.String("domainIdentifier"),
EntityIdentifier: jsii.String("entityIdentifier"),
EntityType: jsii.String("entityType"),
Owner: &OwnerPropertiesProperty{
Group: &OwnerGroupPropertiesProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
},
User: &OwnerUserPropertiesProperty{
UserIdentifier: jsii.String("userIdentifier"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-owner.html
type CfnOwner_OwnerGroupPropertiesProperty ¶ added in v2.196.0
type CfnOwner_OwnerGroupPropertiesProperty struct {
// The ID of the domain unit owners group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-ownergroupproperties.html#cfn-datazone-owner-ownergroupproperties-groupidentifier
//
GroupIdentifier *string `field:"optional" json:"groupIdentifier" yaml:"groupIdentifier"`
}
The properties of the domain unit owners group.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
ownerGroupPropertiesProperty := &OwnerGroupPropertiesProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
}
type CfnOwner_OwnerPropertiesProperty ¶ added in v2.196.0
type CfnOwner_OwnerPropertiesProperty struct {
// Specifies that the domain unit owner is a group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-ownerproperties.html#cfn-datazone-owner-ownerproperties-group
//
Group interface{} `field:"optional" json:"group" yaml:"group"`
// Specifies that the domain unit owner is a user.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-ownerproperties.html#cfn-datazone-owner-ownerproperties-user
//
User interface{} `field:"optional" json:"user" yaml:"user"`
}
The properties of a domain unit's owner.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
ownerPropertiesProperty := &OwnerPropertiesProperty{
Group: &OwnerGroupPropertiesProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
},
User: &OwnerUserPropertiesProperty{
UserIdentifier: jsii.String("userIdentifier"),
},
}
type CfnOwner_OwnerUserPropertiesProperty ¶ added in v2.196.0
type CfnOwner_OwnerUserPropertiesProperty struct {
// The ID of the owner user.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-owner-owneruserproperties.html#cfn-datazone-owner-owneruserproperties-useridentifier
//
UserIdentifier *string `field:"optional" json:"userIdentifier" yaml:"userIdentifier"`
}
The properties of the owner user.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
ownerUserPropertiesProperty := &OwnerUserPropertiesProperty{
UserIdentifier: jsii.String("userIdentifier"),
}
type CfnPolicyGrant ¶ added in v2.214.0
type CfnPolicyGrant interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IPolicyGrantRef
// Specifies the timestamp at which policy grant member was created.
AttrCreatedAt() *string
// Specifies the user who created the policy grant member.
AttrCreatedBy() *string
// The unique identifier of the policy grant returned by the AddPolicyGrant API.
AttrGrantId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The details of the policy grant member.
Detail() interface{}
SetDetail(val interface{})
// The ID of the domain where you want to add a policy grant.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
// The ID of the entity (resource) to which you want to add a policy grant.
EntityIdentifier() *string
SetEntityIdentifier(val *string)
// The type of entity (resource) to which the grant is added.
EntityType() *string
SetEntityType(val *string)
Env() *interfaces.ResourceEnvironment
// 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 tree node.
Node() constructs.Node
// A reference to a PolicyGrant resource.
PolicyGrantRef() *interfacesawsdatazone.PolicyGrantReference
// The type of policy that you want to grant.
PolicyType() *string
SetPolicyType(val *string)
// The principal of the policy grant member.
Principal() interface{}
SetPrincipal(val interface{})
// 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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
Adds a policy grant (an authorization policy) to a specified entity, including domain units, environment blueprint configurations, or environment profiles.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var allDomainUnitsGrantFilter interface{}
var allUsersGrantFilter interface{}
var createEnvironment interface{}
var createEnvironmentFromBlueprint interface{}
var delegateCreateEnvironmentProfile interface{}
cfnPolicyGrant := awscdk.Aws_datazone.NewCfnPolicyGrant(this, jsii.String("MyCfnPolicyGrant"), &CfnPolicyGrantProps{
DomainIdentifier: jsii.String("domainIdentifier"),
EntityIdentifier: jsii.String("entityIdentifier"),
EntityType: jsii.String("entityType"),
PolicyType: jsii.String("policyType"),
// the properties below are optional
Detail: &PolicyGrantDetailProperty{
AddToProjectMemberPool: &AddToProjectMemberPoolPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateAssetType: &CreateAssetTypePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateDomainUnit: &CreateDomainUnitPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateEnvironment: createEnvironment,
CreateEnvironmentFromBlueprint: createEnvironmentFromBlueprint,
CreateEnvironmentProfile: &CreateEnvironmentProfilePolicyGrantDetailProperty{
DomainUnitId: jsii.String("domainUnitId"),
},
CreateFormType: &CreateFormTypePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateGlossary: &CreateGlossaryPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateProject: &CreateProjectPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateProjectFromProjectProfile: &CreateProjectFromProjectProfilePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
ProjectProfiles: []*string{
jsii.String("projectProfiles"),
},
},
DelegateCreateEnvironmentProfile: delegateCreateEnvironmentProfile,
OverrideDomainUnitOwners: &OverrideDomainUnitOwnersPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
OverrideProjectOwners: &OverrideProjectOwnersPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
},
Principal: &PolicyGrantPrincipalProperty{
DomainUnit: &DomainUnitPolicyGrantPrincipalProperty{
DomainUnitDesignation: jsii.String("domainUnitDesignation"),
DomainUnitGrantFilter: &DomainUnitGrantFilterProperty{
AllDomainUnitsGrantFilter: allDomainUnitsGrantFilter,
},
DomainUnitIdentifier: jsii.String("domainUnitIdentifier"),
},
Group: &GroupPolicyGrantPrincipalProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
},
Project: &ProjectPolicyGrantPrincipalProperty{
ProjectDesignation: jsii.String("projectDesignation"),
ProjectGrantFilter: &ProjectGrantFilterProperty{
DomainUnitFilter: &DomainUnitFilterForProjectProperty{
DomainUnit: jsii.String("domainUnit"),
// the properties below are optional
IncludeChildDomainUnits: jsii.Boolean(false),
},
},
ProjectIdentifier: jsii.String("projectIdentifier"),
},
User: &UserPolicyGrantPrincipalProperty{
AllUsersGrantFilter: allUsersGrantFilter,
UserIdentifier: jsii.String("userIdentifier"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html
func NewCfnPolicyGrant ¶ added in v2.214.0
func NewCfnPolicyGrant(scope constructs.Construct, id *string, props *CfnPolicyGrantProps) CfnPolicyGrant
Create a new `AWS::DataZone::PolicyGrant`.
type CfnPolicyGrantProps ¶ added in v2.214.0
type CfnPolicyGrantProps struct {
// The ID of the domain where you want to add a policy grant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The ID of the entity (resource) to which you want to add a policy grant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-entityidentifier
//
EntityIdentifier *string `field:"required" json:"entityIdentifier" yaml:"entityIdentifier"`
// The type of entity (resource) to which the grant is added.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-entitytype
//
EntityType *string `field:"required" json:"entityType" yaml:"entityType"`
// The type of policy that you want to grant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-policytype
//
PolicyType *string `field:"required" json:"policyType" yaml:"policyType"`
// The details of the policy grant member.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-detail
//
Detail interface{} `field:"optional" json:"detail" yaml:"detail"`
// The principal of the policy grant member.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html#cfn-datazone-policygrant-principal
//
Principal interface{} `field:"optional" json:"principal" yaml:"principal"`
}
Properties for defining a `CfnPolicyGrant`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var allDomainUnitsGrantFilter interface{}
var allUsersGrantFilter interface{}
var createEnvironment interface{}
var createEnvironmentFromBlueprint interface{}
var delegateCreateEnvironmentProfile interface{}
cfnPolicyGrantProps := &CfnPolicyGrantProps{
DomainIdentifier: jsii.String("domainIdentifier"),
EntityIdentifier: jsii.String("entityIdentifier"),
EntityType: jsii.String("entityType"),
PolicyType: jsii.String("policyType"),
// the properties below are optional
Detail: &PolicyGrantDetailProperty{
AddToProjectMemberPool: &AddToProjectMemberPoolPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateAssetType: &CreateAssetTypePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateDomainUnit: &CreateDomainUnitPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateEnvironment: createEnvironment,
CreateEnvironmentFromBlueprint: createEnvironmentFromBlueprint,
CreateEnvironmentProfile: &CreateEnvironmentProfilePolicyGrantDetailProperty{
DomainUnitId: jsii.String("domainUnitId"),
},
CreateFormType: &CreateFormTypePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateGlossary: &CreateGlossaryPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateProject: &CreateProjectPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateProjectFromProjectProfile: &CreateProjectFromProjectProfilePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
ProjectProfiles: []*string{
jsii.String("projectProfiles"),
},
},
DelegateCreateEnvironmentProfile: delegateCreateEnvironmentProfile,
OverrideDomainUnitOwners: &OverrideDomainUnitOwnersPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
OverrideProjectOwners: &OverrideProjectOwnersPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
},
Principal: &PolicyGrantPrincipalProperty{
DomainUnit: &DomainUnitPolicyGrantPrincipalProperty{
DomainUnitDesignation: jsii.String("domainUnitDesignation"),
DomainUnitGrantFilter: &DomainUnitGrantFilterProperty{
AllDomainUnitsGrantFilter: allDomainUnitsGrantFilter,
},
DomainUnitIdentifier: jsii.String("domainUnitIdentifier"),
},
Group: &GroupPolicyGrantPrincipalProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
},
Project: &ProjectPolicyGrantPrincipalProperty{
ProjectDesignation: jsii.String("projectDesignation"),
ProjectGrantFilter: &ProjectGrantFilterProperty{
DomainUnitFilter: &DomainUnitFilterForProjectProperty{
DomainUnit: jsii.String("domainUnit"),
// the properties below are optional
IncludeChildDomainUnits: jsii.Boolean(false),
},
},
ProjectIdentifier: jsii.String("projectIdentifier"),
},
User: &UserPolicyGrantPrincipalProperty{
AllUsersGrantFilter: allUsersGrantFilter,
UserIdentifier: jsii.String("userIdentifier"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-policygrant.html
type CfnPolicyGrant_AddToProjectMemberPoolPolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_AddToProjectMemberPoolPolicyGrantDetailProperty struct {
// Specifies whether the policy grant is applied to child domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail.html#cfn-datazone-policygrant-addtoprojectmemberpoolpolicygrantdetail-includechilddomainunits
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
}
The details of the policy grant.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
addToProjectMemberPoolPolicyGrantDetailProperty := &AddToProjectMemberPoolPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
}
type CfnPolicyGrant_CreateAssetTypePolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_CreateAssetTypePolicyGrantDetailProperty struct {
// Specifies whether the policy grant is applied to child domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createassettypepolicygrantdetail.html#cfn-datazone-policygrant-createassettypepolicygrantdetail-includechilddomainunits
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
}
The details of the policy grant.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
createAssetTypePolicyGrantDetailProperty := &CreateAssetTypePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
}
type CfnPolicyGrant_CreateDomainUnitPolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_CreateDomainUnitPolicyGrantDetailProperty struct {
// Specifies whether the policy grant is applied to child domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createdomainunitpolicygrantdetail.html#cfn-datazone-policygrant-createdomainunitpolicygrantdetail-includechilddomainunits
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
}
The details of the policy grant.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
createDomainUnitPolicyGrantDetailProperty := &CreateDomainUnitPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
}
type CfnPolicyGrant_CreateEnvironmentProfilePolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_CreateEnvironmentProfilePolicyGrantDetailProperty struct {
// The ID of the domain unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createenvironmentprofilepolicygrantdetail.html#cfn-datazone-policygrant-createenvironmentprofilepolicygrantdetail-domainunitid
//
DomainUnitId *string `field:"optional" json:"domainUnitId" yaml:"domainUnitId"`
}
The details of the policy grant.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
createEnvironmentProfilePolicyGrantDetailProperty := &CreateEnvironmentProfilePolicyGrantDetailProperty{
DomainUnitId: jsii.String("domainUnitId"),
}
type CfnPolicyGrant_CreateFormTypePolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_CreateFormTypePolicyGrantDetailProperty struct {
// Specifies whether the policy grant is applied to child domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createformtypepolicygrantdetail.html#cfn-datazone-policygrant-createformtypepolicygrantdetail-includechilddomainunits
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
}
The details of the policy grant.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
createFormTypePolicyGrantDetailProperty := &CreateFormTypePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
}
type CfnPolicyGrant_CreateGlossaryPolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_CreateGlossaryPolicyGrantDetailProperty struct {
// Specifies whether the policy grant is applied to child domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createglossarypolicygrantdetail.html#cfn-datazone-policygrant-createglossarypolicygrantdetail-includechilddomainunits
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
}
The details of the policy grant.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
createGlossaryPolicyGrantDetailProperty := &CreateGlossaryPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
}
type CfnPolicyGrant_CreateProjectFromProjectProfilePolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_CreateProjectFromProjectProfilePolicyGrantDetailProperty struct {
// Specifies whether to include child domain units when creating a project from project profile policy grant details.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.html#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-includechilddomainunits
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
// Specifies project profiles when creating a project from project profile policy grant details.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail.html#cfn-datazone-policygrant-createprojectfromprojectprofilepolicygrantdetail-projectprofiles
//
ProjectProfiles *[]*string `field:"optional" json:"projectProfiles" yaml:"projectProfiles"`
}
Specifies whether to create a project from project profile policy grant details.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
createProjectFromProjectProfilePolicyGrantDetailProperty := &CreateProjectFromProjectProfilePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
ProjectProfiles: []*string{
jsii.String("projectProfiles"),
},
}
type CfnPolicyGrant_CreateProjectPolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_CreateProjectPolicyGrantDetailProperty struct {
// Specifies whether the policy grant is applied to child domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-createprojectpolicygrantdetail.html#cfn-datazone-policygrant-createprojectpolicygrantdetail-includechilddomainunits
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
}
The details of the policy grant.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
createProjectPolicyGrantDetailProperty := &CreateProjectPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
}
type CfnPolicyGrant_DomainUnitFilterForProjectProperty ¶ added in v2.214.0
type CfnPolicyGrant_DomainUnitFilterForProjectProperty struct {
// The domain unit ID to use in the filter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitfilterforproject.html#cfn-datazone-policygrant-domainunitfilterforproject-domainunit
//
DomainUnit *string `field:"required" json:"domainUnit" yaml:"domainUnit"`
// Specifies whether to include child domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitfilterforproject.html#cfn-datazone-policygrant-domainunitfilterforproject-includechilddomainunits
//
// Default: - false.
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
}
The domain unit filter of the project grant filter.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
domainUnitFilterForProjectProperty := &DomainUnitFilterForProjectProperty{
DomainUnit: jsii.String("domainUnit"),
// the properties below are optional
IncludeChildDomainUnits: jsii.Boolean(false),
}
type CfnPolicyGrant_DomainUnitGrantFilterProperty ¶ added in v2.214.0
type CfnPolicyGrant_DomainUnitGrantFilterProperty struct {
// Specifies a grant filter containing all domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitgrantfilter.html#cfn-datazone-policygrant-domainunitgrantfilter-alldomainunitsgrantfilter
//
AllDomainUnitsGrantFilter interface{} `field:"required" json:"allDomainUnitsGrantFilter" yaml:"allDomainUnitsGrantFilter"`
}
The grant filter for the domain unit.
In the current release of Amazon DataZone, the only supported filter is the `allDomainUnitsGrantFilter` .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var allDomainUnitsGrantFilter interface{}
domainUnitGrantFilterProperty := &DomainUnitGrantFilterProperty{
AllDomainUnitsGrantFilter: allDomainUnitsGrantFilter,
}
type CfnPolicyGrant_DomainUnitPolicyGrantPrincipalProperty ¶ added in v2.214.0
type CfnPolicyGrant_DomainUnitPolicyGrantPrincipalProperty struct {
// Specifes the designation of the domain unit users.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitdesignation
//
DomainUnitDesignation *string `field:"optional" json:"domainUnitDesignation" yaml:"domainUnitDesignation"`
// The grant filter for the domain unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitgrantfilter
//
DomainUnitGrantFilter interface{} `field:"optional" json:"domainUnitGrantFilter" yaml:"domainUnitGrantFilter"`
// The ID of the domain unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-domainunitpolicygrantprincipal.html#cfn-datazone-policygrant-domainunitpolicygrantprincipal-domainunitidentifier
//
DomainUnitIdentifier *string `field:"optional" json:"domainUnitIdentifier" yaml:"domainUnitIdentifier"`
}
The domain unit principal to whom the policy is granted.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var allDomainUnitsGrantFilter interface{}
domainUnitPolicyGrantPrincipalProperty := &DomainUnitPolicyGrantPrincipalProperty{
DomainUnitDesignation: jsii.String("domainUnitDesignation"),
DomainUnitGrantFilter: &DomainUnitGrantFilterProperty{
AllDomainUnitsGrantFilter: allDomainUnitsGrantFilter,
},
DomainUnitIdentifier: jsii.String("domainUnitIdentifier"),
}
type CfnPolicyGrant_GroupPolicyGrantPrincipalProperty ¶ added in v2.214.0
type CfnPolicyGrant_GroupPolicyGrantPrincipalProperty struct {
// The ID Of the group of the group principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-grouppolicygrantprincipal.html#cfn-datazone-policygrant-grouppolicygrantprincipal-groupidentifier
//
GroupIdentifier *string `field:"required" json:"groupIdentifier" yaml:"groupIdentifier"`
}
The group principal to whom the policy is granted.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
groupPolicyGrantPrincipalProperty := &GroupPolicyGrantPrincipalProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
}
type CfnPolicyGrant_OverrideDomainUnitOwnersPolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_OverrideDomainUnitOwnersPolicyGrantDetailProperty struct {
// Specifies whether the policy is inherited by child domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overridedomainunitownerspolicygrantdetail.html#cfn-datazone-policygrant-overridedomainunitownerspolicygrantdetail-includechilddomainunits
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
}
The grant details of the override domain unit owners policy.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
overrideDomainUnitOwnersPolicyGrantDetailProperty := &OverrideDomainUnitOwnersPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
}
type CfnPolicyGrant_OverrideProjectOwnersPolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_OverrideProjectOwnersPolicyGrantDetailProperty struct {
// Specifies whether the policy is inherited by child domain units.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-overrideprojectownerspolicygrantdetail.html#cfn-datazone-policygrant-overrideprojectownerspolicygrantdetail-includechilddomainunits
//
IncludeChildDomainUnits interface{} `field:"optional" json:"includeChildDomainUnits" yaml:"includeChildDomainUnits"`
}
The details of the override project owners policy grant.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
overrideProjectOwnersPolicyGrantDetailProperty := &OverrideProjectOwnersPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
}
type CfnPolicyGrant_PolicyGrantDetailProperty ¶ added in v2.214.0
type CfnPolicyGrant_PolicyGrantDetailProperty struct {
// Specifies that the policy grant is to be added to the members of the project.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-addtoprojectmemberpool
//
AddToProjectMemberPool interface{} `field:"optional" json:"addToProjectMemberPool" yaml:"addToProjectMemberPool"`
// Specifies that this is a create asset type policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createassettype
//
CreateAssetType interface{} `field:"optional" json:"createAssetType" yaml:"createAssetType"`
// Specifies that this is a create domain unit policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createdomainunit
//
CreateDomainUnit interface{} `field:"optional" json:"createDomainUnit" yaml:"createDomainUnit"`
// Specifies that this is a create environment policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createenvironment
//
CreateEnvironment interface{} `field:"optional" json:"createEnvironment" yaml:"createEnvironment"`
// The details of the policy of creating an environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createenvironmentfromblueprint
//
CreateEnvironmentFromBlueprint interface{} `field:"optional" json:"createEnvironmentFromBlueprint" yaml:"createEnvironmentFromBlueprint"`
// Specifies that this is a create environment profile policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createenvironmentprofile
//
CreateEnvironmentProfile interface{} `field:"optional" json:"createEnvironmentProfile" yaml:"createEnvironmentProfile"`
// Specifies that this is a create form type policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createformtype
//
CreateFormType interface{} `field:"optional" json:"createFormType" yaml:"createFormType"`
// Specifies that this is a create glossary policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createglossary
//
CreateGlossary interface{} `field:"optional" json:"createGlossary" yaml:"createGlossary"`
// Specifies that this is a create project policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createproject
//
CreateProject interface{} `field:"optional" json:"createProject" yaml:"createProject"`
// Specifies whether to create a project from project profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-createprojectfromprojectprofile
//
CreateProjectFromProjectProfile interface{} `field:"optional" json:"createProjectFromProjectProfile" yaml:"createProjectFromProjectProfile"`
// Specifies that this is the delegation of the create environment profile policy.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-delegatecreateenvironmentprofile
//
DelegateCreateEnvironmentProfile interface{} `field:"optional" json:"delegateCreateEnvironmentProfile" yaml:"delegateCreateEnvironmentProfile"`
// Specifies whether to override domain unit owners.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-overridedomainunitowners
//
OverrideDomainUnitOwners interface{} `field:"optional" json:"overrideDomainUnitOwners" yaml:"overrideDomainUnitOwners"`
// Specifies whether to override project owners.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantdetail.html#cfn-datazone-policygrant-policygrantdetail-overrideprojectowners
//
OverrideProjectOwners interface{} `field:"optional" json:"overrideProjectOwners" yaml:"overrideProjectOwners"`
}
The details of the policy grant.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var createEnvironment interface{}
var createEnvironmentFromBlueprint interface{}
var delegateCreateEnvironmentProfile interface{}
policyGrantDetailProperty := &PolicyGrantDetailProperty{
AddToProjectMemberPool: &AddToProjectMemberPoolPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateAssetType: &CreateAssetTypePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateDomainUnit: &CreateDomainUnitPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateEnvironment: createEnvironment,
CreateEnvironmentFromBlueprint: createEnvironmentFromBlueprint,
CreateEnvironmentProfile: &CreateEnvironmentProfilePolicyGrantDetailProperty{
DomainUnitId: jsii.String("domainUnitId"),
},
CreateFormType: &CreateFormTypePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateGlossary: &CreateGlossaryPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateProject: &CreateProjectPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
CreateProjectFromProjectProfile: &CreateProjectFromProjectProfilePolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
ProjectProfiles: []*string{
jsii.String("projectProfiles"),
},
},
DelegateCreateEnvironmentProfile: delegateCreateEnvironmentProfile,
OverrideDomainUnitOwners: &OverrideDomainUnitOwnersPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
OverrideProjectOwners: &OverrideProjectOwnersPolicyGrantDetailProperty{
IncludeChildDomainUnits: jsii.Boolean(false),
},
}
type CfnPolicyGrant_PolicyGrantPrincipalProperty ¶ added in v2.214.0
type CfnPolicyGrant_PolicyGrantPrincipalProperty struct {
// The domain unit of the policy grant principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-domainunit
//
DomainUnit interface{} `field:"optional" json:"domainUnit" yaml:"domainUnit"`
// The group of the policy grant principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-group
//
Group interface{} `field:"optional" json:"group" yaml:"group"`
// The project of the policy grant principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-project
//
Project interface{} `field:"optional" json:"project" yaml:"project"`
// The user of the policy grant principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-policygrantprincipal.html#cfn-datazone-policygrant-policygrantprincipal-user
//
User interface{} `field:"optional" json:"user" yaml:"user"`
}
The policy grant principal.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var allDomainUnitsGrantFilter interface{}
var allUsersGrantFilter interface{}
policyGrantPrincipalProperty := &PolicyGrantPrincipalProperty{
DomainUnit: &DomainUnitPolicyGrantPrincipalProperty{
DomainUnitDesignation: jsii.String("domainUnitDesignation"),
DomainUnitGrantFilter: &DomainUnitGrantFilterProperty{
AllDomainUnitsGrantFilter: allDomainUnitsGrantFilter,
},
DomainUnitIdentifier: jsii.String("domainUnitIdentifier"),
},
Group: &GroupPolicyGrantPrincipalProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
},
Project: &ProjectPolicyGrantPrincipalProperty{
ProjectDesignation: jsii.String("projectDesignation"),
ProjectGrantFilter: &ProjectGrantFilterProperty{
DomainUnitFilter: &DomainUnitFilterForProjectProperty{
DomainUnit: jsii.String("domainUnit"),
// the properties below are optional
IncludeChildDomainUnits: jsii.Boolean(false),
},
},
ProjectIdentifier: jsii.String("projectIdentifier"),
},
User: &UserPolicyGrantPrincipalProperty{
AllUsersGrantFilter: allUsersGrantFilter,
UserIdentifier: jsii.String("userIdentifier"),
},
}
type CfnPolicyGrant_ProjectGrantFilterProperty ¶ added in v2.214.0
type CfnPolicyGrant_ProjectGrantFilterProperty struct {
// The domain unit filter of the project grant filter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectgrantfilter.html#cfn-datazone-policygrant-projectgrantfilter-domainunitfilter
//
DomainUnitFilter interface{} `field:"required" json:"domainUnitFilter" yaml:"domainUnitFilter"`
}
The project grant filter.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
projectGrantFilterProperty := &ProjectGrantFilterProperty{
DomainUnitFilter: &DomainUnitFilterForProjectProperty{
DomainUnit: jsii.String("domainUnit"),
// the properties below are optional
IncludeChildDomainUnits: jsii.Boolean(false),
},
}
type CfnPolicyGrant_ProjectPolicyGrantPrincipalProperty ¶ added in v2.214.0
type CfnPolicyGrant_ProjectPolicyGrantPrincipalProperty struct {
// The project designation of the project policy grant principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html#cfn-datazone-policygrant-projectpolicygrantprincipal-projectdesignation
//
ProjectDesignation *string `field:"optional" json:"projectDesignation" yaml:"projectDesignation"`
// The project grant filter of the project policy grant principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html#cfn-datazone-policygrant-projectpolicygrantprincipal-projectgrantfilter
//
ProjectGrantFilter interface{} `field:"optional" json:"projectGrantFilter" yaml:"projectGrantFilter"`
// The project ID of the project policy grant principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-projectpolicygrantprincipal.html#cfn-datazone-policygrant-projectpolicygrantprincipal-projectidentifier
//
ProjectIdentifier *string `field:"optional" json:"projectIdentifier" yaml:"projectIdentifier"`
}
The project policy grant principal.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
projectPolicyGrantPrincipalProperty := &ProjectPolicyGrantPrincipalProperty{
ProjectDesignation: jsii.String("projectDesignation"),
ProjectGrantFilter: &ProjectGrantFilterProperty{
DomainUnitFilter: &DomainUnitFilterForProjectProperty{
DomainUnit: jsii.String("domainUnit"),
// the properties below are optional
IncludeChildDomainUnits: jsii.Boolean(false),
},
},
ProjectIdentifier: jsii.String("projectIdentifier"),
}
type CfnPolicyGrant_UserPolicyGrantPrincipalProperty ¶ added in v2.214.0
type CfnPolicyGrant_UserPolicyGrantPrincipalProperty struct {
// The all users grant filter of the user policy grant principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-userpolicygrantprincipal.html#cfn-datazone-policygrant-userpolicygrantprincipal-allusersgrantfilter
//
AllUsersGrantFilter interface{} `field:"optional" json:"allUsersGrantFilter" yaml:"allUsersGrantFilter"`
// The user ID of the user policy grant principal.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-policygrant-userpolicygrantprincipal.html#cfn-datazone-policygrant-userpolicygrantprincipal-useridentifier
//
UserIdentifier *string `field:"optional" json:"userIdentifier" yaml:"userIdentifier"`
}
The user policy grant principal.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var allUsersGrantFilter interface{}
userPolicyGrantPrincipalProperty := &UserPolicyGrantPrincipalProperty{
AllUsersGrantFilter: allUsersGrantFilter,
UserIdentifier: jsii.String("userIdentifier"),
}
type CfnProject ¶
type CfnProject interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IProjectRef
// The timestamp of when a project was created.
AttrCreatedAt() *string
// The Amazon DataZone user who created the project.
AttrCreatedBy() *string
// The identifier of a Amazon DataZone domain where the project exists.
AttrDomainId() *string
// The identifier of a project.
AttrId() *string
// The timestamp of when the project was last updated.
AttrLastUpdatedAt() *string
// The status of the project.
AttrProjectStatus() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The description of a project.
Description() *string
SetDescription(val *string)
// The identifier of a Amazon DataZone domain where the project exists.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
// The ID of the domain unit.
DomainUnitId() *string
SetDomainUnitId(val *string)
Env() *interfaces.ResourceEnvironment
// The glossary terms that can be used in this Amazon DataZone project.
GlossaryTerms() *[]*string
SetGlossaryTerms(val *[]*string)
// 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 name of a project.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The ID of the project profile.
ProjectProfileId() *string
SetProjectProfileId(val *string)
// The project profile version to which the project should be updated.
ProjectProfileVersion() *string
SetProjectProfileVersion(val *string)
// A reference to a Project resource.
ProjectRef() *interfacesawsdatazone.ProjectReference
// 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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The user parameters of the project.
UserParameters() interface{}
SetUserParameters(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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The `AWS::DataZone::Project` resource specifies an Amazon DataZone project.
Projects enable a group of users to collaborate on various business use cases that involve publishing, discovering, subscribing to, and consuming data in the Amazon DataZone catalog. Project members consume assets from the Amazon DataZone catalog and produce new assets using one or more analytical workflows.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnProject := awscdk.Aws_datazone.NewCfnProject(this, jsii.String("MyCfnProject"), &CfnProjectProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
DomainUnitId: jsii.String("domainUnitId"),
GlossaryTerms: []*string{
jsii.String("glossaryTerms"),
},
ProjectProfileId: jsii.String("projectProfileId"),
ProjectProfileVersion: jsii.String("projectProfileVersion"),
UserParameters: []interface{}{
&EnvironmentConfigurationUserParameterProperty{
EnvironmentConfigurationName: jsii.String("environmentConfigurationName"),
EnvironmentId: jsii.String("environmentId"),
EnvironmentParameters: []interface{}{
&EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html
func NewCfnProject ¶
func NewCfnProject(scope constructs.Construct, id *string, props *CfnProjectProps) CfnProject
Create a new `AWS::DataZone::Project`.
type CfnProjectMembership ¶ added in v2.143.0
type CfnProjectMembership interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IProjectMembershipRef
AttrMemberIdentifier() *string
AttrMemberIdentifierType() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The designated role of a project member.
Designation() *string
SetDesignation(val *string)
// The ID of the Amazon DataZone domain in which project membership is created.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
Env() *interfaces.ResourceEnvironment
// 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 details about a project member.
Member() interface{}
SetMember(val interface{})
// The tree node.
Node() constructs.Node
// The ID of the project for which this project membership was created.
ProjectIdentifier() *string
SetProjectIdentifier(val *string)
// A reference to a ProjectMembership resource.
ProjectMembershipRef() *interfacesawsdatazone.ProjectMembershipReference
// 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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The `AWS::DataZone::ProjectMembership` resource adds a member to an Amazon DataZone project.
Project members consume assets from the Amazon DataZone catalog and produce new assets using one or more analytical workflows.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnProjectMembership := awscdk.Aws_datazone.NewCfnProjectMembership(this, jsii.String("MyCfnProjectMembership"), &CfnProjectMembershipProps{
Designation: jsii.String("designation"),
DomainIdentifier: jsii.String("domainIdentifier"),
Member: &MemberProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
UserIdentifier: jsii.String("userIdentifier"),
},
ProjectIdentifier: jsii.String("projectIdentifier"),
})
func NewCfnProjectMembership ¶ added in v2.143.0
func NewCfnProjectMembership(scope constructs.Construct, id *string, props *CfnProjectMembershipProps) CfnProjectMembership
Create a new `AWS::DataZone::ProjectMembership`.
type CfnProjectMembershipProps ¶ added in v2.143.0
type CfnProjectMembershipProps struct {
// The designated role of a project member.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#cfn-datazone-projectmembership-designation
//
Designation *string `field:"required" json:"designation" yaml:"designation"`
// The ID of the Amazon DataZone domain in which project membership is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#cfn-datazone-projectmembership-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The details about a project member.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#cfn-datazone-projectmembership-member
//
Member interface{} `field:"required" json:"member" yaml:"member"`
// The ID of the project for which this project membership was created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectmembership.html#cfn-datazone-projectmembership-projectidentifier
//
ProjectIdentifier *string `field:"required" json:"projectIdentifier" yaml:"projectIdentifier"`
}
Properties for defining a `CfnProjectMembership`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnProjectMembershipProps := &CfnProjectMembershipProps{
Designation: jsii.String("designation"),
DomainIdentifier: jsii.String("domainIdentifier"),
Member: &MemberProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
UserIdentifier: jsii.String("userIdentifier"),
},
ProjectIdentifier: jsii.String("projectIdentifier"),
}
type CfnProjectMembership_MemberProperty ¶ added in v2.143.0
type CfnProjectMembership_MemberProperty struct {
// The ID of the group of a project member.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectmembership-member.html#cfn-datazone-projectmembership-member-groupidentifier
//
GroupIdentifier *string `field:"optional" json:"groupIdentifier" yaml:"groupIdentifier"`
// The user ID of a project member.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectmembership-member.html#cfn-datazone-projectmembership-member-useridentifier
//
UserIdentifier *string `field:"optional" json:"userIdentifier" yaml:"userIdentifier"`
}
The details about a project member.
Important - this data type is a UNION, so only one of the following members can be specified when used or returned.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
memberProperty := &MemberProperty{
GroupIdentifier: jsii.String("groupIdentifier"),
UserIdentifier: jsii.String("userIdentifier"),
}
type CfnProjectProfile ¶ added in v2.200.0
type CfnProjectProfile interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IProjectProfileRef
// The timestamp of when the project profile was created.
AttrCreatedAt() *string
// The user who created the project profile.
AttrCreatedBy() *string
// The domain ID of the project profile.
AttrDomainId() *string
// The domain unit ID of the project profile.
AttrDomainUnitId() *string
// The ID of the project profile.
AttrId() *string
// Project profile ID.
AttrIdentifier() *string
// The timestamp at which a project profile was last updated.
AttrLastUpdatedAt() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The description of the project profile.
Description() *string
SetDescription(val *string)
// A domain ID of the project profile.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
// A domain unit ID of the project profile.
DomainUnitIdentifier() *string
SetDomainUnitIdentifier(val *string)
Env() *interfaces.ResourceEnvironment
// Environment configurations of a project profile.
EnvironmentConfigurations() interface{}
SetEnvironmentConfigurations(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 name of a project profile.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// A reference to a ProjectProfile resource.
ProjectProfileRef() *interfacesawsdatazone.ProjectProfileReference
// 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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The status of a project profile.
Status() *string
SetStatus(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The summary of a project profile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnProjectProfile := awscdk.Aws_datazone.NewCfnProjectProfile(this, jsii.String("MyCfnProjectProfile"), &CfnProjectProfileProps{
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
DomainIdentifier: jsii.String("domainIdentifier"),
DomainUnitIdentifier: jsii.String("domainUnitIdentifier"),
EnvironmentConfigurations: []interface{}{
&EnvironmentConfigurationProperty{
AwsRegion: &RegionProperty{
RegionName: jsii.String("regionName"),
},
EnvironmentBlueprintId: jsii.String("environmentBlueprintId"),
Name: jsii.String("name"),
// the properties below are optional
AwsAccount: &AwsAccountProperty{
AwsAccountId: jsii.String("awsAccountId"),
},
ConfigurationParameters: &EnvironmentConfigurationParametersDetailsProperty{
ParameterOverrides: []interface{}{
&EnvironmentConfigurationParameterProperty{
IsEditable: jsii.Boolean(false),
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
ResolvedParameters: []interface{}{
&EnvironmentConfigurationParameterProperty{
IsEditable: jsii.Boolean(false),
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
SsmPath: jsii.String("ssmPath"),
},
DeploymentMode: jsii.String("deploymentMode"),
DeploymentOrder: jsii.Number(123),
Description: jsii.String("description"),
EnvironmentConfigurationId: jsii.String("environmentConfigurationId"),
},
},
Status: jsii.String("status"),
})
func NewCfnProjectProfile ¶ added in v2.200.0
func NewCfnProjectProfile(scope constructs.Construct, id *string, props *CfnProjectProfileProps) CfnProjectProfile
Create a new `AWS::DataZone::ProjectProfile`.
type CfnProjectProfileProps ¶ added in v2.200.0
type CfnProjectProfileProps struct {
// The name of a project profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The description of the project profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// A domain ID of the project profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-domainidentifier
//
DomainIdentifier *string `field:"optional" json:"domainIdentifier" yaml:"domainIdentifier"`
// A domain unit ID of the project profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-domainunitidentifier
//
DomainUnitIdentifier *string `field:"optional" json:"domainUnitIdentifier" yaml:"domainUnitIdentifier"`
// Environment configurations of a project profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-environmentconfigurations
//
EnvironmentConfigurations interface{} `field:"optional" json:"environmentConfigurations" yaml:"environmentConfigurations"`
// The status of a project profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-projectprofile.html#cfn-datazone-projectprofile-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
Properties for defining a `CfnProjectProfile`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnProjectProfileProps := &CfnProjectProfileProps{
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
DomainIdentifier: jsii.String("domainIdentifier"),
DomainUnitIdentifier: jsii.String("domainUnitIdentifier"),
EnvironmentConfigurations: []interface{}{
&EnvironmentConfigurationProperty{
AwsRegion: &RegionProperty{
RegionName: jsii.String("regionName"),
},
EnvironmentBlueprintId: jsii.String("environmentBlueprintId"),
Name: jsii.String("name"),
// the properties below are optional
AwsAccount: &AwsAccountProperty{
AwsAccountId: jsii.String("awsAccountId"),
},
ConfigurationParameters: &EnvironmentConfigurationParametersDetailsProperty{
ParameterOverrides: []interface{}{
&EnvironmentConfigurationParameterProperty{
IsEditable: jsii.Boolean(false),
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
ResolvedParameters: []interface{}{
&EnvironmentConfigurationParameterProperty{
IsEditable: jsii.Boolean(false),
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
SsmPath: jsii.String("ssmPath"),
},
DeploymentMode: jsii.String("deploymentMode"),
DeploymentOrder: jsii.Number(123),
Description: jsii.String("description"),
EnvironmentConfigurationId: jsii.String("environmentConfigurationId"),
},
},
Status: jsii.String("status"),
}
type CfnProjectProfile_AwsAccountProperty ¶ added in v2.201.0
type CfnProjectProfile_AwsAccountProperty struct {
// The account ID of a project.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-awsaccount.html#cfn-datazone-projectprofile-awsaccount-awsaccountid
//
AwsAccountId *string `field:"required" json:"awsAccountId" yaml:"awsAccountId"`
}
The AWS account of the environment.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
awsAccountProperty := &AwsAccountProperty{
AwsAccountId: jsii.String("awsAccountId"),
}
type CfnProjectProfile_EnvironmentConfigurationParameterProperty ¶ added in v2.201.0
type CfnProjectProfile_EnvironmentConfigurationParameterProperty struct {
// Specifies whether the environment parameter is editable.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html#cfn-datazone-projectprofile-environmentconfigurationparameter-iseditable
//
IsEditable interface{} `field:"optional" json:"isEditable" yaml:"isEditable"`
// The name of the environment configuration parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html#cfn-datazone-projectprofile-environmentconfigurationparameter-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The value of the environment configuration parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparameter.html#cfn-datazone-projectprofile-environmentconfigurationparameter-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
The environment configuration parameter.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
environmentConfigurationParameterProperty := &EnvironmentConfigurationParameterProperty{
IsEditable: jsii.Boolean(false),
Name: jsii.String("name"),
Value: jsii.String("value"),
}
type CfnProjectProfile_EnvironmentConfigurationParametersDetailsProperty ¶ added in v2.201.0
type CfnProjectProfile_EnvironmentConfigurationParametersDetailsProperty struct {
// The parameter overrides.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-parameteroverrides
//
ParameterOverrides interface{} `field:"optional" json:"parameterOverrides" yaml:"parameterOverrides"`
// The resolved environment configuration parameters.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-resolvedparameters
//
ResolvedParameters interface{} `field:"optional" json:"resolvedParameters" yaml:"resolvedParameters"`
// Ssm path environment configuration parameters.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfigurationparametersdetails.html#cfn-datazone-projectprofile-environmentconfigurationparametersdetails-ssmpath
//
SsmPath *string `field:"optional" json:"ssmPath" yaml:"ssmPath"`
}
The details of the environment configuration parameter.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
environmentConfigurationParametersDetailsProperty := &EnvironmentConfigurationParametersDetailsProperty{
ParameterOverrides: []interface{}{
&EnvironmentConfigurationParameterProperty{
IsEditable: jsii.Boolean(false),
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
ResolvedParameters: []interface{}{
&EnvironmentConfigurationParameterProperty{
IsEditable: jsii.Boolean(false),
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
SsmPath: jsii.String("ssmPath"),
}
type CfnProjectProfile_EnvironmentConfigurationProperty ¶ added in v2.201.0
type CfnProjectProfile_EnvironmentConfigurationProperty struct {
// The AWS Region of the environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-awsregion
//
AwsRegion interface{} `field:"required" json:"awsRegion" yaml:"awsRegion"`
// The environment blueprint ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-environmentblueprintid
//
EnvironmentBlueprintId *string `field:"required" json:"environmentBlueprintId" yaml:"environmentBlueprintId"`
// The environment name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The AWS account of the environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-awsaccount
//
AwsAccount interface{} `field:"optional" json:"awsAccount" yaml:"awsAccount"`
// The configuration parameters of the environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-configurationparameters
//
ConfigurationParameters interface{} `field:"optional" json:"configurationParameters" yaml:"configurationParameters"`
// The deployment mode of the environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-deploymentmode
//
DeploymentMode *string `field:"optional" json:"deploymentMode" yaml:"deploymentMode"`
// The deployment order of the environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-deploymentorder
//
DeploymentOrder *float64 `field:"optional" json:"deploymentOrder" yaml:"deploymentOrder"`
// The environment description.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-environmentconfiguration.html#cfn-datazone-projectprofile-environmentconfiguration-environmentconfigurationid
//
EnvironmentConfigurationId *string `field:"optional" json:"environmentConfigurationId" yaml:"environmentConfigurationId"`
}
The configuration of an environment.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
environmentConfigurationProperty := &EnvironmentConfigurationProperty{
AwsRegion: &RegionProperty{
RegionName: jsii.String("regionName"),
},
EnvironmentBlueprintId: jsii.String("environmentBlueprintId"),
Name: jsii.String("name"),
// the properties below are optional
AwsAccount: &AwsAccountProperty{
AwsAccountId: jsii.String("awsAccountId"),
},
ConfigurationParameters: &EnvironmentConfigurationParametersDetailsProperty{
ParameterOverrides: []interface{}{
&EnvironmentConfigurationParameterProperty{
IsEditable: jsii.Boolean(false),
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
ResolvedParameters: []interface{}{
&EnvironmentConfigurationParameterProperty{
IsEditable: jsii.Boolean(false),
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
SsmPath: jsii.String("ssmPath"),
},
DeploymentMode: jsii.String("deploymentMode"),
DeploymentOrder: jsii.Number(123),
Description: jsii.String("description"),
EnvironmentConfigurationId: jsii.String("environmentConfigurationId"),
}
type CfnProjectProfile_RegionProperty ¶ added in v2.201.0
type CfnProjectProfile_RegionProperty struct {
// The AWS Region name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-projectprofile-region.html#cfn-datazone-projectprofile-region-regionname
//
RegionName *string `field:"required" json:"regionName" yaml:"regionName"`
}
The AWS Region.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
regionProperty := &RegionProperty{
RegionName: jsii.String("regionName"),
}
type CfnProjectProps ¶
type CfnProjectProps struct {
// The identifier of a Amazon DataZone domain where the project exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The name of a project.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The description of a project.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The ID of the domain unit.
//
// This parameter is not required and if it is not specified, then the project is created at the root domain unit level.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-domainunitid
//
DomainUnitId *string `field:"optional" json:"domainUnitId" yaml:"domainUnitId"`
// The glossary terms that can be used in this Amazon DataZone project.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-glossaryterms
//
GlossaryTerms *[]*string `field:"optional" json:"glossaryTerms" yaml:"glossaryTerms"`
// The ID of the project profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-projectprofileid
//
ProjectProfileId *string `field:"optional" json:"projectProfileId" yaml:"projectProfileId"`
// The project profile version to which the project should be updated.
//
// You can only specify the following string for this parameter: `latest` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-projectprofileversion
//
ProjectProfileVersion *string `field:"optional" json:"projectProfileVersion" yaml:"projectProfileVersion"`
// The user parameters of the project.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-userparameters
//
UserParameters interface{} `field:"optional" json:"userParameters" yaml:"userParameters"`
}
Properties for defining a `CfnProject`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnProjectProps := &CfnProjectProps{
DomainIdentifier: jsii.String("domainIdentifier"),
Name: jsii.String("name"),
// the properties below are optional
Description: jsii.String("description"),
DomainUnitId: jsii.String("domainUnitId"),
GlossaryTerms: []*string{
jsii.String("glossaryTerms"),
},
ProjectProfileId: jsii.String("projectProfileId"),
ProjectProfileVersion: jsii.String("projectProfileVersion"),
UserParameters: []interface{}{
&EnvironmentConfigurationUserParameterProperty{
EnvironmentConfigurationName: jsii.String("environmentConfigurationName"),
EnvironmentId: jsii.String("environmentId"),
EnvironmentParameters: []interface{}{
&EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html
type CfnProject_EnvironmentConfigurationUserParameterProperty ¶ added in v2.197.0
type CfnProject_EnvironmentConfigurationUserParameterProperty struct {
// The environment configuration name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentconfigurationuserparameter.html#cfn-datazone-project-environmentconfigurationuserparameter-environmentconfigurationname
//
EnvironmentConfigurationName *string `field:"optional" json:"environmentConfigurationName" yaml:"environmentConfigurationName"`
// The ID of the environment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentconfigurationuserparameter.html#cfn-datazone-project-environmentconfigurationuserparameter-environmentid
//
EnvironmentId *string `field:"optional" json:"environmentId" yaml:"environmentId"`
// The environment parameters.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentconfigurationuserparameter.html#cfn-datazone-project-environmentconfigurationuserparameter-environmentparameters
//
EnvironmentParameters interface{} `field:"optional" json:"environmentParameters" yaml:"environmentParameters"`
}
The environment configuration user parameters.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
environmentConfigurationUserParameterProperty := &EnvironmentConfigurationUserParameterProperty{
EnvironmentConfigurationName: jsii.String("environmentConfigurationName"),
EnvironmentId: jsii.String("environmentId"),
EnvironmentParameters: []interface{}{
&EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
}
type CfnProject_EnvironmentParameterProperty ¶ added in v2.197.0
type CfnProject_EnvironmentParameterProperty struct {
// The name of an environment profile parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentparameter.html#cfn-datazone-project-environmentparameter-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The value of an environment profile parameter.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-project-environmentparameter.html#cfn-datazone-project-environmentparameter-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
The parameter details of an evironment profile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
environmentParameterProperty := &EnvironmentParameterProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
}
type CfnSubscriptionTarget ¶
type CfnSubscriptionTarget interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.ISubscriptionTargetRef
// The asset types included in the subscription target.
ApplicableAssetTypes() *[]*string
SetApplicableAssetTypes(val *[]*string)
// The timestamp of when the subscription target was created.
AttrCreatedAt() *string
// The Amazon DataZone user who created the subscription target.
AttrCreatedBy() *string
// The identifier of the Amazon DataZone domain in which the subscription target exists.
AttrDomainId() *string
// The identifier of the environment of the subscription target.
AttrEnvironmentId() *string
// The identifier of the subscription target.
AttrId() *string
// The identifier of the project specified in the subscription target.
AttrProjectId() *string
// The timestamp of when the subscription target was updated.
AttrUpdatedAt() *string
// The Amazon DataZone user who updated the subscription target.
AttrUpdatedBy() *string
// The authorized principals included in the subscription target.
AuthorizedPrincipals() *[]*string
SetAuthorizedPrincipals(val *[]*string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The ID of the Amazon DataZone domain in which subscription target is created.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
Env() *interfaces.ResourceEnvironment
// The ID of the environment in which subscription target is created.
EnvironmentIdentifier() *string
SetEnvironmentIdentifier(val *string)
// 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 manage access role that is used to create the subscription target.
ManageAccessRole() *string
SetManageAccessRole(val *string)
// The name of the subscription target.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// The provider of the subscription target.
Provider() *string
SetProvider(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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The configuration of the subscription target.
SubscriptionTargetConfig() interface{}
SetSubscriptionTargetConfig(val interface{})
// A reference to a SubscriptionTarget resource.
SubscriptionTargetRef() *interfacesawsdatazone.SubscriptionTargetReference
// The type of the subscription target.
Type() *string
SetType(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The `AWS::DataZone::SubscriptionTarget` resource specifies an Amazon DataZone subscription target.
Subscription targets enable you to access the data to which you have subscribed in your projects. A subscription target specifies the location (for example, a database or a schema) and the required permissions (for example, an IAM role) that Amazon DataZone can use to establish a connection with the source data and to create the necessary grants so that members of the Amazon DataZone project can start querying the data to which they have subscribed.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnSubscriptionTarget := awscdk.Aws_datazone.NewCfnSubscriptionTarget(this, jsii.String("MyCfnSubscriptionTarget"), &CfnSubscriptionTargetProps{
ApplicableAssetTypes: []*string{
jsii.String("applicableAssetTypes"),
},
AuthorizedPrincipals: []*string{
jsii.String("authorizedPrincipals"),
},
DomainIdentifier: jsii.String("domainIdentifier"),
EnvironmentIdentifier: jsii.String("environmentIdentifier"),
Name: jsii.String("name"),
SubscriptionTargetConfig: []interface{}{
&SubscriptionTargetFormProperty{
Content: jsii.String("content"),
FormName: jsii.String("formName"),
},
},
Type: jsii.String("type"),
// the properties below are optional
ManageAccessRole: jsii.String("manageAccessRole"),
Provider: jsii.String("provider"),
})
func NewCfnSubscriptionTarget ¶
func NewCfnSubscriptionTarget(scope constructs.Construct, id *string, props *CfnSubscriptionTargetProps) CfnSubscriptionTarget
Create a new `AWS::DataZone::SubscriptionTarget`.
type CfnSubscriptionTargetProps ¶
type CfnSubscriptionTargetProps struct {
// The asset types included in the subscription target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-applicableassettypes
//
ApplicableAssetTypes *[]*string `field:"required" json:"applicableAssetTypes" yaml:"applicableAssetTypes"`
// The authorized principals included in the subscription target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-authorizedprincipals
//
AuthorizedPrincipals *[]*string `field:"required" json:"authorizedPrincipals" yaml:"authorizedPrincipals"`
// The ID of the Amazon DataZone domain in which subscription target is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The ID of the environment in which subscription target is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-environmentidentifier
//
EnvironmentIdentifier *string `field:"required" json:"environmentIdentifier" yaml:"environmentIdentifier"`
// The name of the subscription target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The configuration of the subscription target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-subscriptiontargetconfig
//
SubscriptionTargetConfig interface{} `field:"required" json:"subscriptionTargetConfig" yaml:"subscriptionTargetConfig"`
// The type of the subscription target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// The manage access role that is used to create the subscription target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-manageaccessrole
//
ManageAccessRole *string `field:"optional" json:"manageAccessRole" yaml:"manageAccessRole"`
// The provider of the subscription target.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-provider
//
Provider *string `field:"optional" json:"provider" yaml:"provider"`
}
Properties for defining a `CfnSubscriptionTarget`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnSubscriptionTargetProps := &CfnSubscriptionTargetProps{
ApplicableAssetTypes: []*string{
jsii.String("applicableAssetTypes"),
},
AuthorizedPrincipals: []*string{
jsii.String("authorizedPrincipals"),
},
DomainIdentifier: jsii.String("domainIdentifier"),
EnvironmentIdentifier: jsii.String("environmentIdentifier"),
Name: jsii.String("name"),
SubscriptionTargetConfig: []interface{}{
&SubscriptionTargetFormProperty{
Content: jsii.String("content"),
FormName: jsii.String("formName"),
},
},
Type: jsii.String("type"),
// the properties below are optional
ManageAccessRole: jsii.String("manageAccessRole"),
Provider: jsii.String("provider"),
}
type CfnSubscriptionTarget_SubscriptionTargetFormProperty ¶
type CfnSubscriptionTarget_SubscriptionTargetFormProperty struct {
// The content of the subscription target configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-subscriptiontarget-subscriptiontargetform.html#cfn-datazone-subscriptiontarget-subscriptiontargetform-content
//
Content *string `field:"required" json:"content" yaml:"content"`
// The form name included in the subscription target configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-subscriptiontarget-subscriptiontargetform.html#cfn-datazone-subscriptiontarget-subscriptiontargetform-formname
//
FormName *string `field:"required" json:"formName" yaml:"formName"`
}
The details of the subscription target configuration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
subscriptionTargetFormProperty := &SubscriptionTargetFormProperty{
Content: jsii.String("content"),
FormName: jsii.String("formName"),
}
type CfnUserProfile ¶ added in v2.143.0
type CfnUserProfile interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdatazone.IUserProfileRef
AttrDetails() awscdk.IResolvable
// The identifier of a Amazon DataZone domain in which a user profile exists.
AttrDomainId() *string
// The ID of the user profile.
AttrId() *string
// The type of the user profile.
AttrType() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// 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
// The identifier of a Amazon DataZone domain in which a user profile exists.
DomainIdentifier() *string
SetDomainIdentifier(val *string)
Env() *interfaces.ResourceEnvironment
// 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 tree node.
Node() constructs.Node
// 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 stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The status of the user profile.
Status() *string
SetStatus(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// 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{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The identifier of the user for which the user profile is created.
UserIdentifier() *string
SetUserIdentifier(val *string)
// A reference to a UserProfile resource.
UserProfileRef() *interfacesawsdatazone.UserProfileReference
// The user type of the user for which the user profile is created.
UserType() *string
SetUserType(val *string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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, typeHint awscdk.ResolutionTypeHint) 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)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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{})
}
The user type of the user for which the user profile is created.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnUserProfile := awscdk.Aws_datazone.NewCfnUserProfile(this, jsii.String("MyCfnUserProfile"), &CfnUserProfileProps{
DomainIdentifier: jsii.String("domainIdentifier"),
UserIdentifier: jsii.String("userIdentifier"),
// the properties below are optional
Status: jsii.String("status"),
UserType: jsii.String("userType"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html
func NewCfnUserProfile ¶ added in v2.143.0
func NewCfnUserProfile(scope constructs.Construct, id *string, props *CfnUserProfileProps) CfnUserProfile
Create a new `AWS::DataZone::UserProfile`.
type CfnUserProfileProps ¶ added in v2.143.0
type CfnUserProfileProps struct {
// The identifier of a Amazon DataZone domain in which a user profile exists.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#cfn-datazone-userprofile-domainidentifier
//
DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"`
// The identifier of the user for which the user profile is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#cfn-datazone-userprofile-useridentifier
//
UserIdentifier *string `field:"required" json:"userIdentifier" yaml:"userIdentifier"`
// The status of the user profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#cfn-datazone-userprofile-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
// The user type of the user for which the user profile is created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html#cfn-datazone-userprofile-usertype
//
UserType *string `field:"optional" json:"userType" yaml:"userType"`
}
Properties for defining a `CfnUserProfile`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnUserProfileProps := &CfnUserProfileProps{
DomainIdentifier: jsii.String("domainIdentifier"),
UserIdentifier: jsii.String("userIdentifier"),
// the properties below are optional
Status: jsii.String("status"),
UserType: jsii.String("userType"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-userprofile.html
type CfnUserProfile_IamUserProfileDetailsProperty ¶ added in v2.143.0
type CfnUserProfile_IamUserProfileDetailsProperty struct {
// The ARN of an IAM user profile in Amazon DataZone.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-iamuserprofiledetails.html#cfn-datazone-userprofile-iamuserprofiledetails-arn
//
Arn *string `field:"optional" json:"arn" yaml:"arn"`
}
The details of an IAM user profile in Amazon DataZone.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
iamUserProfileDetailsProperty := &IamUserProfileDetailsProperty{
Arn: jsii.String("arn"),
}
type CfnUserProfile_SsoUserProfileDetailsProperty ¶ added in v2.143.0
type CfnUserProfile_SsoUserProfileDetailsProperty struct {
// The first name included in the single sign-on details of the user profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-ssouserprofiledetails.html#cfn-datazone-userprofile-ssouserprofiledetails-firstname
//
FirstName *string `field:"optional" json:"firstName" yaml:"firstName"`
// The last name included in the single sign-on details of the user profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-ssouserprofiledetails.html#cfn-datazone-userprofile-ssouserprofiledetails-lastname
//
LastName *string `field:"optional" json:"lastName" yaml:"lastName"`
// The username included in the single sign-on details of the user profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-ssouserprofiledetails.html#cfn-datazone-userprofile-ssouserprofiledetails-username
//
Username *string `field:"optional" json:"username" yaml:"username"`
}
The single sign-on details of the user profile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
ssoUserProfileDetailsProperty := &SsoUserProfileDetailsProperty{
FirstName: jsii.String("firstName"),
LastName: jsii.String("lastName"),
Username: jsii.String("username"),
}
type CfnUserProfile_UserProfileDetailsProperty ¶ added in v2.143.0
type CfnUserProfile_UserProfileDetailsProperty struct {
// The IAM details included in the user profile details.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-userprofiledetails.html#cfn-datazone-userprofile-userprofiledetails-iam
//
Iam interface{} `field:"optional" json:"iam" yaml:"iam"`
// The single sign-on details included in the user profile details.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-userprofile-userprofiledetails.html#cfn-datazone-userprofile-userprofiledetails-sso
//
Sso interface{} `field:"optional" json:"sso" yaml:"sso"`
}
The details of the user profile in Amazon DataZone.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
userProfileDetailsProperty := &UserProfileDetailsProperty{
Iam: &IamUserProfileDetailsProperty{
Arn: jsii.String("arn"),
},
Sso: &SsoUserProfileDetailsProperty{
FirstName: jsii.String("firstName"),
LastName: jsii.String("lastName"),
Username: jsii.String("username"),
},
}
Source Files
¶
- CfnConnection.go
- CfnConnectionProps.go
- CfnConnection_AmazonQPropertiesInputProperty.go
- CfnConnection_AthenaPropertiesInputProperty.go
- CfnConnection_AuthenticationConfigurationInputProperty.go
- CfnConnection_AuthorizationCodePropertiesProperty.go
- CfnConnection_AwsLocationProperty.go
- CfnConnection_BasicAuthenticationCredentialsProperty.go
- CfnConnection_ConnectionPropertiesInputProperty.go
- CfnConnection_GlueConnectionInputProperty.go
- CfnConnection_GlueOAuth2CredentialsProperty.go
- CfnConnection_GluePropertiesInputProperty.go
- CfnConnection_HyperPodPropertiesInputProperty.go
- CfnConnection_IamPropertiesInputProperty.go
- CfnConnection_LineageSyncScheduleProperty.go
- CfnConnection_OAuth2ClientApplicationProperty.go
- CfnConnection_OAuth2PropertiesProperty.go
- CfnConnection_PhysicalConnectionRequirementsProperty.go
- CfnConnection_RedshiftCredentialsProperty.go
- CfnConnection_RedshiftLineageSyncConfigurationInputProperty.go
- CfnConnection_RedshiftPropertiesInputProperty.go
- CfnConnection_RedshiftStoragePropertiesProperty.go
- CfnConnection_S3PropertiesInputProperty.go
- CfnConnection_SparkEmrPropertiesInputProperty.go
- CfnConnection_SparkGlueArgsProperty.go
- CfnConnection_SparkGluePropertiesInputProperty.go
- CfnConnection_UsernamePasswordProperty.go
- CfnConnection__checks.go
- CfnDataSource.go
- CfnDataSourceProps.go
- CfnDataSource_DataSourceConfigurationInputProperty.go
- CfnDataSource_FilterExpressionProperty.go
- CfnDataSource_FormInputProperty.go
- CfnDataSource_GlueRunConfigurationInputProperty.go
- CfnDataSource_RecommendationConfigurationProperty.go
- CfnDataSource_RedshiftClusterStorageProperty.go
- CfnDataSource_RedshiftCredentialConfigurationProperty.go
- CfnDataSource_RedshiftRunConfigurationInputProperty.go
- CfnDataSource_RedshiftServerlessStorageProperty.go
- CfnDataSource_RedshiftStorageProperty.go
- CfnDataSource_RelationalFilterConfigurationProperty.go
- CfnDataSource_SageMakerRunConfigurationInputProperty.go
- CfnDataSource_ScheduleConfigurationProperty.go
- CfnDataSource__checks.go
- CfnDomain.go
- CfnDomainProps.go
- CfnDomainUnit.go
- CfnDomainUnitProps.go
- CfnDomainUnit__checks.go
- CfnDomain_SingleSignOnProperty.go
- CfnDomain__checks.go
- CfnEnvironment.go
- CfnEnvironmentActions.go
- CfnEnvironmentActionsProps.go
- CfnEnvironmentActions_AwsConsoleLinkParametersProperty.go
- CfnEnvironmentActions__checks.go
- CfnEnvironmentBlueprintConfiguration.go
- CfnEnvironmentBlueprintConfigurationProps.go
- CfnEnvironmentBlueprintConfiguration_LakeFormationConfigurationProperty.go
- CfnEnvironmentBlueprintConfiguration_ProvisioningConfigurationProperty.go
- CfnEnvironmentBlueprintConfiguration_RegionalParameterProperty.go
- CfnEnvironmentBlueprintConfiguration__checks.go
- CfnEnvironmentProfile.go
- CfnEnvironmentProfileProps.go
- CfnEnvironmentProfile_EnvironmentParameterProperty.go
- CfnEnvironmentProfile__checks.go
- CfnEnvironmentProps.go
- CfnEnvironment_EnvironmentParameterProperty.go
- CfnEnvironment__checks.go
- CfnFormType.go
- CfnFormTypeProps.go
- CfnFormType_ModelProperty.go
- CfnFormType__checks.go
- CfnGroupProfile.go
- CfnGroupProfileProps.go
- CfnGroupProfile__checks.go
- CfnOwner.go
- CfnOwnerProps.go
- CfnOwner_OwnerGroupPropertiesProperty.go
- CfnOwner_OwnerPropertiesProperty.go
- CfnOwner_OwnerUserPropertiesProperty.go
- CfnOwner__checks.go
- CfnPolicyGrant.go
- CfnPolicyGrantProps.go
- CfnPolicyGrant_AddToProjectMemberPoolPolicyGrantDetailProperty.go
- CfnPolicyGrant_CreateAssetTypePolicyGrantDetailProperty.go
- CfnPolicyGrant_CreateDomainUnitPolicyGrantDetailProperty.go
- CfnPolicyGrant_CreateEnvironmentProfilePolicyGrantDetailProperty.go
- CfnPolicyGrant_CreateFormTypePolicyGrantDetailProperty.go
- CfnPolicyGrant_CreateGlossaryPolicyGrantDetailProperty.go
- CfnPolicyGrant_CreateProjectFromProjectProfilePolicyGrantDetailProperty.go
- CfnPolicyGrant_CreateProjectPolicyGrantDetailProperty.go
- CfnPolicyGrant_DomainUnitFilterForProjectProperty.go
- CfnPolicyGrant_DomainUnitGrantFilterProperty.go
- CfnPolicyGrant_DomainUnitPolicyGrantPrincipalProperty.go
- CfnPolicyGrant_GroupPolicyGrantPrincipalProperty.go
- CfnPolicyGrant_OverrideDomainUnitOwnersPolicyGrantDetailProperty.go
- CfnPolicyGrant_OverrideProjectOwnersPolicyGrantDetailProperty.go
- CfnPolicyGrant_PolicyGrantDetailProperty.go
- CfnPolicyGrant_PolicyGrantPrincipalProperty.go
- CfnPolicyGrant_ProjectGrantFilterProperty.go
- CfnPolicyGrant_ProjectPolicyGrantPrincipalProperty.go
- CfnPolicyGrant_UserPolicyGrantPrincipalProperty.go
- CfnPolicyGrant__checks.go
- CfnProject.go
- CfnProjectMembership.go
- CfnProjectMembershipProps.go
- CfnProjectMembership_MemberProperty.go
- CfnProjectMembership__checks.go
- CfnProjectProfile.go
- CfnProjectProfileProps.go
- CfnProjectProfile_AwsAccountProperty.go
- CfnProjectProfile_EnvironmentConfigurationParameterProperty.go
- CfnProjectProfile_EnvironmentConfigurationParametersDetailsProperty.go
- CfnProjectProfile_EnvironmentConfigurationProperty.go
- CfnProjectProfile_RegionProperty.go
- CfnProjectProfile__checks.go
- CfnProjectProps.go
- CfnProject_EnvironmentConfigurationUserParameterProperty.go
- CfnProject_EnvironmentParameterProperty.go
- CfnProject__checks.go
- CfnSubscriptionTarget.go
- CfnSubscriptionTargetProps.go
- CfnSubscriptionTarget_SubscriptionTargetFormProperty.go
- CfnSubscriptionTarget__checks.go
- CfnUserProfile.go
- CfnUserProfileProps.go
- CfnUserProfile_IamUserProfileDetailsProperty.go
- CfnUserProfile_SsoUserProfileDetailsProperty.go
- CfnUserProfile_UserProfileDetailsProperty.go
- CfnUserProfile__checks.go
- main.go