Documentation ¶
Index ¶
- func CfnClassifier_CFN_RESOURCE_TYPE_NAME() *string
- func CfnClassifier_IsCfnElement(x interface{}) *bool
- func CfnClassifier_IsCfnResource(x interface{}) *bool
- func CfnClassifier_IsConstruct(x interface{}) *bool
- 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 CfnCrawler_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCrawler_IsCfnElement(x interface{}) *bool
- func CfnCrawler_IsCfnResource(x interface{}) *bool
- func CfnCrawler_IsConstruct(x interface{}) *bool
- func CfnCustomEntityType_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCustomEntityType_IsCfnElement(x interface{}) *bool
- func CfnCustomEntityType_IsCfnResource(x interface{}) *bool
- func CfnCustomEntityType_IsConstruct(x interface{}) *bool
- func CfnDataCatalogEncryptionSettings_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataCatalogEncryptionSettings_IsCfnElement(x interface{}) *bool
- func CfnDataCatalogEncryptionSettings_IsCfnResource(x interface{}) *bool
- func CfnDataCatalogEncryptionSettings_IsConstruct(x interface{}) *bool
- func CfnDataQualityRuleset_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataQualityRuleset_IsCfnElement(x interface{}) *bool
- func CfnDataQualityRuleset_IsCfnResource(x interface{}) *bool
- func CfnDataQualityRuleset_IsConstruct(x interface{}) *bool
- func CfnDatabase_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDatabase_IsCfnElement(x interface{}) *bool
- func CfnDatabase_IsCfnResource(x interface{}) *bool
- func CfnDatabase_IsConstruct(x interface{}) *bool
- func CfnDevEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDevEndpoint_IsCfnElement(x interface{}) *bool
- func CfnDevEndpoint_IsCfnResource(x interface{}) *bool
- func CfnDevEndpoint_IsConstruct(x interface{}) *bool
- func CfnJob_CFN_RESOURCE_TYPE_NAME() *string
- func CfnJob_IsCfnElement(x interface{}) *bool
- func CfnJob_IsCfnResource(x interface{}) *bool
- func CfnJob_IsConstruct(x interface{}) *bool
- func CfnMLTransform_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMLTransform_IsCfnElement(x interface{}) *bool
- func CfnMLTransform_IsCfnResource(x interface{}) *bool
- func CfnMLTransform_IsConstruct(x interface{}) *bool
- func CfnPartition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPartition_IsCfnElement(x interface{}) *bool
- func CfnPartition_IsCfnResource(x interface{}) *bool
- func CfnPartition_IsConstruct(x interface{}) *bool
- func CfnRegistry_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRegistry_IsCfnElement(x interface{}) *bool
- func CfnRegistry_IsCfnResource(x interface{}) *bool
- func CfnRegistry_IsConstruct(x interface{}) *bool
- func CfnSchemaVersionMetadata_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSchemaVersionMetadata_IsCfnElement(x interface{}) *bool
- func CfnSchemaVersionMetadata_IsCfnResource(x interface{}) *bool
- func CfnSchemaVersionMetadata_IsConstruct(x interface{}) *bool
- func CfnSchemaVersion_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSchemaVersion_IsCfnElement(x interface{}) *bool
- func CfnSchemaVersion_IsCfnResource(x interface{}) *bool
- func CfnSchemaVersion_IsConstruct(x interface{}) *bool
- func CfnSchema_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSchema_IsCfnElement(x interface{}) *bool
- func CfnSchema_IsCfnResource(x interface{}) *bool
- func CfnSchema_IsConstruct(x interface{}) *bool
- func CfnSecurityConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSecurityConfiguration_IsCfnElement(x interface{}) *bool
- func CfnSecurityConfiguration_IsCfnResource(x interface{}) *bool
- func CfnSecurityConfiguration_IsConstruct(x interface{}) *bool
- func CfnTableOptimizer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTableOptimizer_IsCfnElement(x interface{}) *bool
- func CfnTableOptimizer_IsCfnResource(x interface{}) *bool
- func CfnTableOptimizer_IsConstruct(x interface{}) *bool
- func CfnTable_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTable_IsCfnElement(x interface{}) *bool
- func CfnTable_IsCfnResource(x interface{}) *bool
- func CfnTable_IsConstruct(x interface{}) *bool
- func CfnTrigger_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTrigger_IsCfnElement(x interface{}) *bool
- func CfnTrigger_IsCfnResource(x interface{}) *bool
- func CfnTrigger_IsConstruct(x interface{}) *bool
- func CfnUsageProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUsageProfile_IsCfnElement(x interface{}) *bool
- func CfnUsageProfile_IsCfnResource(x interface{}) *bool
- func CfnUsageProfile_IsConstruct(x interface{}) *bool
- func CfnWorkflow_CFN_RESOURCE_TYPE_NAME() *string
- func CfnWorkflow_IsCfnElement(x interface{}) *bool
- func CfnWorkflow_IsCfnResource(x interface{}) *bool
- func CfnWorkflow_IsConstruct(x interface{}) *bool
- func NewCfnClassifier_Override(c CfnClassifier, scope constructs.Construct, id *string, ...)
- func NewCfnConnection_Override(c CfnConnection, scope constructs.Construct, id *string, ...)
- func NewCfnCrawler_Override(c CfnCrawler, scope constructs.Construct, id *string, props *CfnCrawlerProps)
- func NewCfnCustomEntityType_Override(c CfnCustomEntityType, scope constructs.Construct, id *string, ...)
- func NewCfnDataCatalogEncryptionSettings_Override(c CfnDataCatalogEncryptionSettings, scope constructs.Construct, id *string, ...)
- func NewCfnDataQualityRuleset_Override(c CfnDataQualityRuleset, scope constructs.Construct, id *string, ...)
- func NewCfnDatabase_Override(c CfnDatabase, scope constructs.Construct, id *string, props *CfnDatabaseProps)
- func NewCfnDevEndpoint_Override(c CfnDevEndpoint, scope constructs.Construct, id *string, ...)
- func NewCfnJob_Override(c CfnJob, scope constructs.Construct, id *string, props *CfnJobProps)
- func NewCfnMLTransform_Override(c CfnMLTransform, scope constructs.Construct, id *string, ...)
- func NewCfnPartition_Override(c CfnPartition, scope constructs.Construct, id *string, ...)
- func NewCfnRegistry_Override(c CfnRegistry, scope constructs.Construct, id *string, props *CfnRegistryProps)
- func NewCfnSchemaVersionMetadata_Override(c CfnSchemaVersionMetadata, scope constructs.Construct, id *string, ...)
- func NewCfnSchemaVersion_Override(c CfnSchemaVersion, scope constructs.Construct, id *string, ...)
- func NewCfnSchema_Override(c CfnSchema, scope constructs.Construct, id *string, props *CfnSchemaProps)
- func NewCfnSecurityConfiguration_Override(c CfnSecurityConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnTableOptimizer_Override(c CfnTableOptimizer, scope constructs.Construct, id *string, ...)
- func NewCfnTable_Override(c CfnTable, scope constructs.Construct, id *string, props *CfnTableProps)
- func NewCfnTrigger_Override(c CfnTrigger, scope constructs.Construct, id *string, props *CfnTriggerProps)
- func NewCfnUsageProfile_Override(c CfnUsageProfile, scope constructs.Construct, id *string, ...)
- func NewCfnWorkflow_Override(c CfnWorkflow, scope constructs.Construct, id *string, props *CfnWorkflowProps)
- type CfnClassifier
- type CfnClassifierProps
- type CfnClassifier_CsvClassifierProperty
- type CfnClassifier_GrokClassifierProperty
- type CfnClassifier_JsonClassifierProperty
- type CfnClassifier_XMLClassifierProperty
- type CfnConnection
- type CfnConnectionProps
- type CfnConnection_ConnectionInputProperty
- type CfnConnection_PhysicalConnectionRequirementsProperty
- type CfnCrawler
- type CfnCrawlerProps
- type CfnCrawler_CatalogTargetProperty
- type CfnCrawler_DeltaTargetProperty
- type CfnCrawler_DynamoDBTargetProperty
- type CfnCrawler_IcebergTargetProperty
- type CfnCrawler_JdbcTargetProperty
- type CfnCrawler_LakeFormationConfigurationProperty
- type CfnCrawler_MongoDBTargetProperty
- type CfnCrawler_RecrawlPolicyProperty
- type CfnCrawler_S3TargetProperty
- type CfnCrawler_ScheduleProperty
- type CfnCrawler_SchemaChangePolicyProperty
- type CfnCrawler_TargetsProperty
- type CfnCustomEntityType
- type CfnCustomEntityTypeProps
- type CfnDataCatalogEncryptionSettings
- type CfnDataCatalogEncryptionSettingsProps
- type CfnDataCatalogEncryptionSettings_ConnectionPasswordEncryptionProperty
- type CfnDataCatalogEncryptionSettings_DataCatalogEncryptionSettingsProperty
- type CfnDataCatalogEncryptionSettings_EncryptionAtRestProperty
- type CfnDataQualityRuleset
- type CfnDataQualityRulesetProps
- type CfnDataQualityRuleset_DataQualityTargetTableProperty
- type CfnDatabase
- type CfnDatabaseProps
- type CfnDatabase_DataLakePrincipalProperty
- type CfnDatabase_DatabaseIdentifierProperty
- type CfnDatabase_DatabaseInputProperty
- type CfnDatabase_FederatedDatabaseProperty
- type CfnDatabase_PrincipalPrivilegesProperty
- type CfnDevEndpoint
- type CfnDevEndpointProps
- type CfnJob
- type CfnJobProps
- type CfnJob_ConnectionsListProperty
- type CfnJob_ExecutionPropertyProperty
- type CfnJob_JobCommandProperty
- type CfnJob_NotificationPropertyProperty
- type CfnMLTransform
- type CfnMLTransformProps
- type CfnMLTransform_FindMatchesParametersProperty
- type CfnMLTransform_GlueTablesProperty
- type CfnMLTransform_InputRecordTablesProperty
- type CfnMLTransform_MLUserDataEncryptionProperty
- type CfnMLTransform_TransformEncryptionProperty
- type CfnMLTransform_TransformParametersProperty
- type CfnPartition
- type CfnPartitionProps
- type CfnPartition_ColumnProperty
- type CfnPartition_OrderProperty
- type CfnPartition_PartitionInputProperty
- type CfnPartition_SchemaIdProperty
- type CfnPartition_SchemaReferenceProperty
- type CfnPartition_SerdeInfoProperty
- type CfnPartition_SkewedInfoProperty
- type CfnPartition_StorageDescriptorProperty
- type CfnRegistry
- type CfnRegistryProps
- type CfnSchema
- type CfnSchemaProps
- type CfnSchemaVersion
- type CfnSchemaVersionMetadata
- type CfnSchemaVersionMetadataProps
- type CfnSchemaVersionProps
- type CfnSchemaVersion_SchemaProperty
- type CfnSchema_RegistryProperty
- type CfnSchema_SchemaVersionProperty
- type CfnSecurityConfiguration
- type CfnSecurityConfigurationProps
- type CfnSecurityConfiguration_CloudWatchEncryptionProperty
- type CfnSecurityConfiguration_EncryptionConfigurationProperty
- type CfnSecurityConfiguration_JobBookmarksEncryptionProperty
- type CfnSecurityConfiguration_S3EncryptionProperty
- type CfnTable
- type CfnTableOptimizer
- type CfnTableOptimizerProps
- type CfnTableOptimizer_TableOptimizerConfigurationProperty
- type CfnTableProps
- type CfnTable_ColumnProperty
- type CfnTable_IcebergInputProperty
- type CfnTable_OpenTableFormatInputProperty
- type CfnTable_OrderProperty
- type CfnTable_SchemaIdProperty
- type CfnTable_SchemaReferenceProperty
- type CfnTable_SerdeInfoProperty
- type CfnTable_SkewedInfoProperty
- type CfnTable_StorageDescriptorProperty
- type CfnTable_TableIdentifierProperty
- type CfnTable_TableInputProperty
- type CfnTrigger
- type CfnTriggerProps
- type CfnTrigger_ActionProperty
- type CfnTrigger_ConditionProperty
- type CfnTrigger_EventBatchingConditionProperty
- type CfnTrigger_NotificationPropertyProperty
- type CfnTrigger_PredicateProperty
- type CfnUsageProfile
- type CfnUsageProfileProps
- type CfnUsageProfile_ConfigurationObjectProperty
- type CfnUsageProfile_ProfileConfigurationProperty
- type CfnWorkflow
- type CfnWorkflowProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnClassifier_CFN_RESOURCE_TYPE_NAME ¶
func CfnClassifier_CFN_RESOURCE_TYPE_NAME() *string
func CfnClassifier_IsCfnElement ¶
func CfnClassifier_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 CfnClassifier_IsCfnResource ¶
func CfnClassifier_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnClassifier_IsConstruct ¶
func CfnClassifier_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 CfnConnection_CFN_RESOURCE_TYPE_NAME ¶
func CfnConnection_CFN_RESOURCE_TYPE_NAME() *string
func CfnConnection_IsCfnElement ¶
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 ¶
func CfnConnection_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnConnection_IsConstruct ¶
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 CfnCrawler_CFN_RESOURCE_TYPE_NAME ¶
func CfnCrawler_CFN_RESOURCE_TYPE_NAME() *string
func CfnCrawler_IsCfnElement ¶
func CfnCrawler_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 CfnCrawler_IsCfnResource ¶
func CfnCrawler_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCrawler_IsConstruct ¶
func CfnCrawler_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 CfnCustomEntityType_CFN_RESOURCE_TYPE_NAME ¶ added in v2.119.0
func CfnCustomEntityType_CFN_RESOURCE_TYPE_NAME() *string
func CfnCustomEntityType_IsCfnElement ¶ added in v2.119.0
func CfnCustomEntityType_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 CfnCustomEntityType_IsCfnResource ¶ added in v2.119.0
func CfnCustomEntityType_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCustomEntityType_IsConstruct ¶ added in v2.119.0
func CfnCustomEntityType_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 CfnDataCatalogEncryptionSettings_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataCatalogEncryptionSettings_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataCatalogEncryptionSettings_IsCfnElement ¶
func CfnDataCatalogEncryptionSettings_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 CfnDataCatalogEncryptionSettings_IsCfnResource ¶
func CfnDataCatalogEncryptionSettings_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDataCatalogEncryptionSettings_IsConstruct ¶
func CfnDataCatalogEncryptionSettings_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 CfnDataQualityRuleset_CFN_RESOURCE_TYPE_NAME ¶ added in v2.86.0
func CfnDataQualityRuleset_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataQualityRuleset_IsCfnElement ¶ added in v2.86.0
func CfnDataQualityRuleset_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 CfnDataQualityRuleset_IsCfnResource ¶ added in v2.86.0
func CfnDataQualityRuleset_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDataQualityRuleset_IsConstruct ¶ added in v2.86.0
func CfnDataQualityRuleset_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 CfnDatabase_CFN_RESOURCE_TYPE_NAME ¶
func CfnDatabase_CFN_RESOURCE_TYPE_NAME() *string
func CfnDatabase_IsCfnElement ¶
func CfnDatabase_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 CfnDatabase_IsCfnResource ¶
func CfnDatabase_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDatabase_IsConstruct ¶
func CfnDatabase_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 CfnDevEndpoint_CFN_RESOURCE_TYPE_NAME ¶
func CfnDevEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnDevEndpoint_IsCfnElement ¶
func CfnDevEndpoint_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 CfnDevEndpoint_IsCfnResource ¶
func CfnDevEndpoint_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDevEndpoint_IsConstruct ¶
func CfnDevEndpoint_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 CfnJob_CFN_RESOURCE_TYPE_NAME ¶
func CfnJob_CFN_RESOURCE_TYPE_NAME() *string
func CfnJob_IsCfnElement ¶
func CfnJob_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 CfnJob_IsCfnResource ¶
func CfnJob_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnJob_IsConstruct ¶
func CfnJob_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 CfnMLTransform_CFN_RESOURCE_TYPE_NAME ¶
func CfnMLTransform_CFN_RESOURCE_TYPE_NAME() *string
func CfnMLTransform_IsCfnElement ¶
func CfnMLTransform_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 CfnMLTransform_IsCfnResource ¶
func CfnMLTransform_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMLTransform_IsConstruct ¶
func CfnMLTransform_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 CfnPartition_CFN_RESOURCE_TYPE_NAME ¶
func CfnPartition_CFN_RESOURCE_TYPE_NAME() *string
func CfnPartition_IsCfnElement ¶
func CfnPartition_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 CfnPartition_IsCfnResource ¶
func CfnPartition_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPartition_IsConstruct ¶
func CfnPartition_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 CfnRegistry_CFN_RESOURCE_TYPE_NAME ¶
func CfnRegistry_CFN_RESOURCE_TYPE_NAME() *string
func CfnRegistry_IsCfnElement ¶
func CfnRegistry_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 CfnRegistry_IsCfnResource ¶
func CfnRegistry_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRegistry_IsConstruct ¶
func CfnRegistry_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 CfnSchemaVersionMetadata_CFN_RESOURCE_TYPE_NAME ¶
func CfnSchemaVersionMetadata_CFN_RESOURCE_TYPE_NAME() *string
func CfnSchemaVersionMetadata_IsCfnElement ¶
func CfnSchemaVersionMetadata_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 CfnSchemaVersionMetadata_IsCfnResource ¶
func CfnSchemaVersionMetadata_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSchemaVersionMetadata_IsConstruct ¶
func CfnSchemaVersionMetadata_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 CfnSchemaVersion_CFN_RESOURCE_TYPE_NAME ¶
func CfnSchemaVersion_CFN_RESOURCE_TYPE_NAME() *string
func CfnSchemaVersion_IsCfnElement ¶
func CfnSchemaVersion_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 CfnSchemaVersion_IsCfnResource ¶
func CfnSchemaVersion_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSchemaVersion_IsConstruct ¶
func CfnSchemaVersion_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 CfnSchema_CFN_RESOURCE_TYPE_NAME ¶
func CfnSchema_CFN_RESOURCE_TYPE_NAME() *string
func CfnSchema_IsCfnElement ¶
func CfnSchema_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 CfnSchema_IsCfnResource ¶
func CfnSchema_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSchema_IsConstruct ¶
func CfnSchema_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 CfnSecurityConfiguration_CFN_RESOURCE_TYPE_NAME ¶
func CfnSecurityConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnSecurityConfiguration_IsCfnElement ¶
func CfnSecurityConfiguration_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 CfnSecurityConfiguration_IsCfnResource ¶
func CfnSecurityConfiguration_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSecurityConfiguration_IsConstruct ¶
func CfnSecurityConfiguration_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 CfnTableOptimizer_CFN_RESOURCE_TYPE_NAME ¶ added in v2.127.0
func CfnTableOptimizer_CFN_RESOURCE_TYPE_NAME() *string
func CfnTableOptimizer_IsCfnElement ¶ added in v2.127.0
func CfnTableOptimizer_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 CfnTableOptimizer_IsCfnResource ¶ added in v2.127.0
func CfnTableOptimizer_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTableOptimizer_IsConstruct ¶ added in v2.127.0
func CfnTableOptimizer_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 CfnTable_CFN_RESOURCE_TYPE_NAME ¶
func CfnTable_CFN_RESOURCE_TYPE_NAME() *string
func CfnTable_IsCfnElement ¶
func CfnTable_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 CfnTable_IsCfnResource ¶
func CfnTable_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTable_IsConstruct ¶
func CfnTable_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 CfnTrigger_CFN_RESOURCE_TYPE_NAME ¶
func CfnTrigger_CFN_RESOURCE_TYPE_NAME() *string
func CfnTrigger_IsCfnElement ¶
func CfnTrigger_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 CfnTrigger_IsCfnResource ¶
func CfnTrigger_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTrigger_IsConstruct ¶
func CfnTrigger_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 CfnUsageProfile_CFN_RESOURCE_TYPE_NAME ¶ added in v2.161.0
func CfnUsageProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnUsageProfile_IsCfnElement ¶ added in v2.161.0
func CfnUsageProfile_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 CfnUsageProfile_IsCfnResource ¶ added in v2.161.0
func CfnUsageProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnUsageProfile_IsConstruct ¶ added in v2.161.0
func CfnUsageProfile_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 CfnWorkflow_CFN_RESOURCE_TYPE_NAME ¶
func CfnWorkflow_CFN_RESOURCE_TYPE_NAME() *string
func CfnWorkflow_IsCfnElement ¶
func CfnWorkflow_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 CfnWorkflow_IsCfnResource ¶
func CfnWorkflow_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnWorkflow_IsConstruct ¶
func CfnWorkflow_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 NewCfnClassifier_Override ¶
func NewCfnClassifier_Override(c CfnClassifier, scope constructs.Construct, id *string, props *CfnClassifierProps)
func NewCfnConnection_Override ¶
func NewCfnConnection_Override(c CfnConnection, scope constructs.Construct, id *string, props *CfnConnectionProps)
func NewCfnCrawler_Override ¶
func NewCfnCrawler_Override(c CfnCrawler, scope constructs.Construct, id *string, props *CfnCrawlerProps)
func NewCfnCustomEntityType_Override ¶ added in v2.119.0
func NewCfnCustomEntityType_Override(c CfnCustomEntityType, scope constructs.Construct, id *string, props *CfnCustomEntityTypeProps)
func NewCfnDataCatalogEncryptionSettings_Override ¶
func NewCfnDataCatalogEncryptionSettings_Override(c CfnDataCatalogEncryptionSettings, scope constructs.Construct, id *string, props *CfnDataCatalogEncryptionSettingsProps)
func NewCfnDataQualityRuleset_Override ¶ added in v2.86.0
func NewCfnDataQualityRuleset_Override(c CfnDataQualityRuleset, scope constructs.Construct, id *string, props *CfnDataQualityRulesetProps)
func NewCfnDatabase_Override ¶
func NewCfnDatabase_Override(c CfnDatabase, scope constructs.Construct, id *string, props *CfnDatabaseProps)
func NewCfnDevEndpoint_Override ¶
func NewCfnDevEndpoint_Override(c CfnDevEndpoint, scope constructs.Construct, id *string, props *CfnDevEndpointProps)
func NewCfnJob_Override ¶
func NewCfnJob_Override(c CfnJob, scope constructs.Construct, id *string, props *CfnJobProps)
func NewCfnMLTransform_Override ¶
func NewCfnMLTransform_Override(c CfnMLTransform, scope constructs.Construct, id *string, props *CfnMLTransformProps)
func NewCfnPartition_Override ¶
func NewCfnPartition_Override(c CfnPartition, scope constructs.Construct, id *string, props *CfnPartitionProps)
func NewCfnRegistry_Override ¶
func NewCfnRegistry_Override(c CfnRegistry, scope constructs.Construct, id *string, props *CfnRegistryProps)
func NewCfnSchemaVersionMetadata_Override ¶
func NewCfnSchemaVersionMetadata_Override(c CfnSchemaVersionMetadata, scope constructs.Construct, id *string, props *CfnSchemaVersionMetadataProps)
func NewCfnSchemaVersion_Override ¶
func NewCfnSchemaVersion_Override(c CfnSchemaVersion, scope constructs.Construct, id *string, props *CfnSchemaVersionProps)
func NewCfnSchema_Override ¶
func NewCfnSchema_Override(c CfnSchema, scope constructs.Construct, id *string, props *CfnSchemaProps)
func NewCfnSecurityConfiguration_Override ¶
func NewCfnSecurityConfiguration_Override(c CfnSecurityConfiguration, scope constructs.Construct, id *string, props *CfnSecurityConfigurationProps)
func NewCfnTableOptimizer_Override ¶ added in v2.127.0
func NewCfnTableOptimizer_Override(c CfnTableOptimizer, scope constructs.Construct, id *string, props *CfnTableOptimizerProps)
func NewCfnTable_Override ¶
func NewCfnTable_Override(c CfnTable, scope constructs.Construct, id *string, props *CfnTableProps)
func NewCfnTrigger_Override ¶
func NewCfnTrigger_Override(c CfnTrigger, scope constructs.Construct, id *string, props *CfnTriggerProps)
func NewCfnUsageProfile_Override ¶ added in v2.161.0
func NewCfnUsageProfile_Override(c CfnUsageProfile, scope constructs.Construct, id *string, props *CfnUsageProfileProps)
func NewCfnWorkflow_Override ¶
func NewCfnWorkflow_Override(c CfnWorkflow, scope constructs.Construct, id *string, props *CfnWorkflowProps)
Types ¶
type CfnClassifier ¶
type CfnClassifier interface { awscdk.CfnResource awscdk.IInspectable 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 // A classifier for comma-separated values (CSV). CsvClassifier() interface{} SetCsvClassifier(val interface{}) // A classifier that uses `grok` . GrokClassifier() interface{} SetGrokClassifier(val interface{}) // A classifier for JSON content. JsonClassifier() interface{} SetJsonClassifier(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 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 // 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{} // A classifier for XML content. XmlClassifier() interface{} SetXmlClassifier(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::Glue::Classifier` resource creates an AWS Glue classifier that categorizes data sources and specifies schemas.
For more information, see [Adding Classifiers to a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-classifier.html) and [Classifier Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-classifiers.html#aws-glue-api-crawler-classifiers-Classifier) in the *AWS Glue Developer Guide* .
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" cfnClassifier := awscdk.Aws_glue.NewCfnClassifier(this, jsii.String("MyCfnClassifier"), &CfnClassifierProps{ CsvClassifier: &CsvClassifierProperty{ AllowSingleColumn: jsii.Boolean(false), ContainsCustomDatatype: []*string{ jsii.String("containsCustomDatatype"), }, ContainsHeader: jsii.String("containsHeader"), CustomDatatypeConfigured: jsii.Boolean(false), Delimiter: jsii.String("delimiter"), DisableValueTrimming: jsii.Boolean(false), Header: []*string{ jsii.String("header"), }, Name: jsii.String("name"), QuoteSymbol: jsii.String("quoteSymbol"), }, GrokClassifier: &GrokClassifierProperty{ Classification: jsii.String("classification"), GrokPattern: jsii.String("grokPattern"), // the properties below are optional CustomPatterns: jsii.String("customPatterns"), Name: jsii.String("name"), }, JsonClassifier: &JsonClassifierProperty{ JsonPath: jsii.String("jsonPath"), // the properties below are optional Name: jsii.String("name"), }, XmlClassifier: &XMLClassifierProperty{ Classification: jsii.String("classification"), RowTag: jsii.String("rowTag"), // the properties below are optional Name: jsii.String("name"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html
func NewCfnClassifier ¶
func NewCfnClassifier(scope constructs.Construct, id *string, props *CfnClassifierProps) CfnClassifier
type CfnClassifierProps ¶
type CfnClassifierProps struct { // A classifier for comma-separated values (CSV). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-csvclassifier // CsvClassifier interface{} `field:"optional" json:"csvClassifier" yaml:"csvClassifier"` // A classifier that uses `grok` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-grokclassifier // GrokClassifier interface{} `field:"optional" json:"grokClassifier" yaml:"grokClassifier"` // A classifier for JSON content. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-jsonclassifier // JsonClassifier interface{} `field:"optional" json:"jsonClassifier" yaml:"jsonClassifier"` // A classifier for XML content. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html#cfn-glue-classifier-xmlclassifier // XmlClassifier interface{} `field:"optional" json:"xmlClassifier" yaml:"xmlClassifier"` }
Properties for defining a `CfnClassifier`.
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" cfnClassifierProps := &CfnClassifierProps{ CsvClassifier: &CsvClassifierProperty{ AllowSingleColumn: jsii.Boolean(false), ContainsCustomDatatype: []*string{ jsii.String("containsCustomDatatype"), }, ContainsHeader: jsii.String("containsHeader"), CustomDatatypeConfigured: jsii.Boolean(false), Delimiter: jsii.String("delimiter"), DisableValueTrimming: jsii.Boolean(false), Header: []*string{ jsii.String("header"), }, Name: jsii.String("name"), QuoteSymbol: jsii.String("quoteSymbol"), }, GrokClassifier: &GrokClassifierProperty{ Classification: jsii.String("classification"), GrokPattern: jsii.String("grokPattern"), // the properties below are optional CustomPatterns: jsii.String("customPatterns"), Name: jsii.String("name"), }, JsonClassifier: &JsonClassifierProperty{ JsonPath: jsii.String("jsonPath"), // the properties below are optional Name: jsii.String("name"), }, XmlClassifier: &XMLClassifierProperty{ Classification: jsii.String("classification"), RowTag: jsii.String("rowTag"), // the properties below are optional Name: jsii.String("name"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-classifier.html
type CfnClassifier_CsvClassifierProperty ¶
type CfnClassifier_CsvClassifierProperty struct { // Enables the processing of files that contain only one column. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-allowsinglecolumn // AllowSingleColumn interface{} `field:"optional" json:"allowSingleColumn" yaml:"allowSingleColumn"` // Indicates whether the CSV file contains custom data types. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-containscustomdatatype // ContainsCustomDatatype *[]*string `field:"optional" json:"containsCustomDatatype" yaml:"containsCustomDatatype"` // Indicates whether the CSV file contains a header. // // A value of `UNKNOWN` specifies that the classifier will detect whether the CSV file contains headings. // // A value of `PRESENT` specifies that the CSV file contains headings. // // A value of `ABSENT` specifies that the CSV file does not contain headings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-containsheader // ContainsHeader *string `field:"optional" json:"containsHeader" yaml:"containsHeader"` // Enables the configuration of custom data types. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-customdatatypeconfigured // CustomDatatypeConfigured interface{} `field:"optional" json:"customDatatypeConfigured" yaml:"customDatatypeConfigured"` // A custom symbol to denote what separates each column entry in the row. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-delimiter // Delimiter *string `field:"optional" json:"delimiter" yaml:"delimiter"` // Specifies not to trim values before identifying the type of column values. // // The default value is `true` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-disablevaluetrimming // DisableValueTrimming interface{} `field:"optional" json:"disableValueTrimming" yaml:"disableValueTrimming"` // A list of strings representing column names. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-header // Header *[]*string `field:"optional" json:"header" yaml:"header"` // The name of the classifier. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-name // Name *string `field:"optional" json:"name" yaml:"name"` // A custom symbol to denote what combines content into a single column value. // // It must be different from the column delimiter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-csvclassifier.html#cfn-glue-classifier-csvclassifier-quotesymbol // QuoteSymbol *string `field:"optional" json:"quoteSymbol" yaml:"quoteSymbol"` }
A classifier for custom `CSV` content.
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" csvClassifierProperty := &CsvClassifierProperty{ AllowSingleColumn: jsii.Boolean(false), ContainsCustomDatatype: []*string{ jsii.String("containsCustomDatatype"), }, ContainsHeader: jsii.String("containsHeader"), CustomDatatypeConfigured: jsii.Boolean(false), Delimiter: jsii.String("delimiter"), DisableValueTrimming: jsii.Boolean(false), Header: []*string{ jsii.String("header"), }, Name: jsii.String("name"), QuoteSymbol: jsii.String("quoteSymbol"), }
type CfnClassifier_GrokClassifierProperty ¶
type CfnClassifier_GrokClassifierProperty struct { // An identifier of the data format that the classifier matches, such as Twitter, JSON, Omniture logs, and so on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-classification // Classification *string `field:"required" json:"classification" yaml:"classification"` // The grok pattern applied to a data store by this classifier. // // For more information, see built-in patterns in [Writing Custom Classifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-grokpattern // GrokPattern *string `field:"required" json:"grokPattern" yaml:"grokPattern"` // Optional custom grok patterns defined by this classifier. // // For more information, see custom patterns in [Writing Custom Classifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-custompatterns // CustomPatterns *string `field:"optional" json:"customPatterns" yaml:"customPatterns"` // The name of the classifier. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-grokclassifier.html#cfn-glue-classifier-grokclassifier-name // Name *string `field:"optional" json:"name" yaml:"name"` }
A classifier that uses `grok` patterns.
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" grokClassifierProperty := &GrokClassifierProperty{ Classification: jsii.String("classification"), GrokPattern: jsii.String("grokPattern"), // the properties below are optional CustomPatterns: jsii.String("customPatterns"), Name: jsii.String("name"), }
type CfnClassifier_JsonClassifierProperty ¶
type CfnClassifier_JsonClassifierProperty struct { // A `JsonPath` string defining the JSON data for the classifier to classify. // // AWS Glue supports a subset of `JsonPath` , as described in [Writing JsonPath Custom Classifiers](https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html#cfn-glue-classifier-jsonclassifier-jsonpath // JsonPath *string `field:"required" json:"jsonPath" yaml:"jsonPath"` // The name of the classifier. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-jsonclassifier.html#cfn-glue-classifier-jsonclassifier-name // Name *string `field:"optional" json:"name" yaml:"name"` }
A classifier for `JSON` content.
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" jsonClassifierProperty := &JsonClassifierProperty{ JsonPath: jsii.String("jsonPath"), // the properties below are optional Name: jsii.String("name"), }
type CfnClassifier_XMLClassifierProperty ¶
type CfnClassifier_XMLClassifierProperty struct { // An identifier of the data format that the classifier matches. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-classification // Classification *string `field:"required" json:"classification" yaml:"classification"` // The XML tag designating the element that contains each record in an XML document being parsed. // // This can't identify a self-closing element (closed by `/>` ). An empty row element that contains only attributes can be parsed as long as it ends with a closing tag (for example, `<row item_a="A" item_b="B"></row>` is okay, but `<row item_a="A" item_b="B" />` is not). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-rowtag // RowTag *string `field:"required" json:"rowTag" yaml:"rowTag"` // The name of the classifier. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-classifier-xmlclassifier.html#cfn-glue-classifier-xmlclassifier-name // Name *string `field:"optional" json:"name" yaml:"name"` }
A classifier for `XML` content.
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" xMLClassifierProperty := &XMLClassifierProperty{ Classification: jsii.String("classification"), RowTag: jsii.String("rowTag"), // the properties below are optional Name: jsii.String("name"), }
type CfnConnection ¶
type CfnConnection interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // The ID of the data catalog to create the catalog object in. CatalogId() *string SetCatalogId(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The connection that you want to create. ConnectionInput() interface{} SetConnectionInput(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // 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 // 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::Glue::Connection` resource specifies an AWS Glue connection to a data source.
For more information, see [Adding a Connection to Your Data Store](https://docs.aws.amazon.com/glue/latest/dg/populate-add-connection.html) and [Connection Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-connections.html#aws-glue-api-catalog-connections-Connection) in the *AWS Glue Developer Guide* .
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 connectionProperties interface{} cfnConnection := awscdk.Aws_glue.NewCfnConnection(this, jsii.String("MyCfnConnection"), &CfnConnectionProps{ CatalogId: jsii.String("catalogId"), ConnectionInput: &ConnectionInputProperty{ ConnectionType: jsii.String("connectionType"), // the properties below are optional ConnectionProperties: connectionProperties, Description: jsii.String("description"), MatchCriteria: []*string{ jsii.String("matchCriteria"), }, Name: jsii.String("name"), PhysicalConnectionRequirements: &PhysicalConnectionRequirementsProperty{ AvailabilityZone: jsii.String("availabilityZone"), SecurityGroupIdList: []*string{ jsii.String("securityGroupIdList"), }, SubnetId: jsii.String("subnetId"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html
func NewCfnConnection ¶
func NewCfnConnection(scope constructs.Construct, id *string, props *CfnConnectionProps) CfnConnection
type CfnConnectionProps ¶
type CfnConnectionProps struct { // The ID of the data catalog to create the catalog object in. // // Currently, this should be the AWS account ID. // // > To specify the account ID, you can use the `Ref` intrinsic function with the `AWS::AccountId` pseudo parameter. For example: `!Ref AWS::AccountId` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html#cfn-glue-connection-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The connection that you want to create. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html#cfn-glue-connection-connectioninput // ConnectionInput interface{} `field:"required" json:"connectionInput" yaml:"connectionInput"` }
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" var connectionProperties interface{} cfnConnectionProps := &CfnConnectionProps{ CatalogId: jsii.String("catalogId"), ConnectionInput: &ConnectionInputProperty{ ConnectionType: jsii.String("connectionType"), // the properties below are optional ConnectionProperties: connectionProperties, Description: jsii.String("description"), MatchCriteria: []*string{ jsii.String("matchCriteria"), }, Name: jsii.String("name"), PhysicalConnectionRequirements: &PhysicalConnectionRequirementsProperty{ AvailabilityZone: jsii.String("availabilityZone"), SecurityGroupIdList: []*string{ jsii.String("securityGroupIdList"), }, SubnetId: jsii.String("subnetId"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-connection.html
type CfnConnection_ConnectionInputProperty ¶
type CfnConnection_ConnectionInputProperty struct { // The type of the connection. Currently, these types are supported:. // // - `JDBC` - Designates a connection to a database through Java Database Connectivity (JDBC). // // `JDBC` Connections use the following ConnectionParameters. // // - Required: All of ( `HOST` , `PORT` , `JDBC_ENGINE` ) or `JDBC_CONNECTION_URL` . // - Required: All of ( `USERNAME` , `PASSWORD` ) or `SECRET_ID` . // - Optional: `JDBC_ENFORCE_SSL` , `CUSTOM_JDBC_CERT` , `CUSTOM_JDBC_CERT_STRING` , `SKIP_CUSTOM_JDBC_CERT_VALIDATION` . These parameters are used to configure SSL with JDBC. // - `KAFKA` - Designates a connection to an Apache Kafka streaming platform. // // `KAFKA` Connections use the following ConnectionParameters. // // - Required: `KAFKA_BOOTSTRAP_SERVERS` . // - Optional: `KAFKA_SSL_ENABLED` , `KAFKA_CUSTOM_CERT` , `KAFKA_SKIP_CUSTOM_CERT_VALIDATION` . These parameters are used to configure SSL with `KAFKA` . // - Optional: `KAFKA_CLIENT_KEYSTORE` , `KAFKA_CLIENT_KEYSTORE_PASSWORD` , `KAFKA_CLIENT_KEY_PASSWORD` , `ENCRYPTED_KAFKA_CLIENT_KEYSTORE_PASSWORD` , `ENCRYPTED_KAFKA_CLIENT_KEY_PASSWORD` . These parameters are used to configure TLS client configuration with SSL in `KAFKA` . // - Optional: `KAFKA_SASL_MECHANISM` . Can be specified as `SCRAM-SHA-512` , `GSSAPI` , or `AWS_MSK_IAM` . // - Optional: `KAFKA_SASL_SCRAM_USERNAME` , `KAFKA_SASL_SCRAM_PASSWORD` , `ENCRYPTED_KAFKA_SASL_SCRAM_PASSWORD` . These parameters are used to configure SASL/SCRAM-SHA-512 authentication with `KAFKA` . // - Optional: `KAFKA_SASL_GSSAPI_KEYTAB` , `KAFKA_SASL_GSSAPI_KRB5_CONF` , `KAFKA_SASL_GSSAPI_SERVICE` , `KAFKA_SASL_GSSAPI_PRINCIPAL` . These parameters are used to configure SASL/GSSAPI authentication with `KAFKA` . // - `MONGODB` - Designates a connection to a MongoDB document database. // // `MONGODB` Connections use the following ConnectionParameters. // // - Required: `CONNECTION_URL` . // - Required: All of ( `USERNAME` , `PASSWORD` ) or `SECRET_ID` . // - `SALESFORCE` - Designates a connection to Salesforce using OAuth authencation. // // - Requires the `AuthenticationConfiguration` member to be configured. // - `VIEW_VALIDATION_REDSHIFT` - Designates a connection used for view validation by Amazon Redshift. // - `VIEW_VALIDATION_ATHENA` - Designates a connection used for view validation by Amazon Athena. // - `NETWORK` - Designates a network connection to a data source within an Amazon Virtual Private Cloud environment (Amazon VPC). // // `NETWORK` Connections do not require ConnectionParameters. Instead, provide a PhysicalConnectionRequirements. // - `MARKETPLACE` - Uses configuration settings contained in a connector purchased from AWS Marketplace to read from and write to data stores that are not natively supported by AWS Glue . // // `MARKETPLACE` Connections use the following ConnectionParameters. // // - Required: `CONNECTOR_TYPE` , `CONNECTOR_URL` , `CONNECTOR_CLASS_NAME` , `CONNECTION_URL` . // - Required for `JDBC` `CONNECTOR_TYPE` connections: All of ( `USERNAME` , `PASSWORD` ) or `SECRET_ID` . // - `CUSTOM` - Uses configuration settings contained in a custom connector to read from and write to data stores that are not natively supported by AWS Glue . // // `SFTP` is not supported. // // For more information about how optional ConnectionProperties are used to configure features in AWS Glue , consult [AWS Glue connection properties](https://docs.aws.amazon.com/glue/latest/dg/connection-defining.html) . // // For more information about how optional ConnectionProperties are used to configure features in AWS Glue Studio, consult [Using connectors and connections](https://docs.aws.amazon.com/glue/latest/ug/connectors-chapter.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectiontype // ConnectionType *string `field:"required" json:"connectionType" yaml:"connectionType"` // These key-value pairs define parameters for the connection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-connectionproperties // ConnectionProperties interface{} `field:"optional" json:"connectionProperties" yaml:"connectionProperties"` // The description of the connection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-description // Description *string `field:"optional" json:"description" yaml:"description"` // A list of criteria that can be used in selecting this connection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-matchcriteria // MatchCriteria *[]*string `field:"optional" json:"matchCriteria" yaml:"matchCriteria"` // The name of the connection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-name // Name *string `field:"optional" json:"name" yaml:"name"` // The physical connection requirements, such as virtual private cloud (VPC) and `SecurityGroup` , that are needed to successfully make this connection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-connectioninput.html#cfn-glue-connection-connectioninput-physicalconnectionrequirements // PhysicalConnectionRequirements interface{} `field:"optional" json:"physicalConnectionRequirements" yaml:"physicalConnectionRequirements"` }
A structure that is used to specify a connection to create or update.
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 connectionProperties interface{} connectionInputProperty := &ConnectionInputProperty{ ConnectionType: jsii.String("connectionType"), // the properties below are optional ConnectionProperties: connectionProperties, Description: jsii.String("description"), MatchCriteria: []*string{ jsii.String("matchCriteria"), }, Name: jsii.String("name"), PhysicalConnectionRequirements: &PhysicalConnectionRequirementsProperty{ AvailabilityZone: jsii.String("availabilityZone"), SecurityGroupIdList: []*string{ jsii.String("securityGroupIdList"), }, SubnetId: jsii.String("subnetId"), }, }
type CfnConnection_PhysicalConnectionRequirementsProperty ¶
type CfnConnection_PhysicalConnectionRequirementsProperty struct { // The connection's Availability Zone. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-availabilityzone // AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"` // The security group ID list used by the connection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-securitygroupidlist // SecurityGroupIdList *[]*string `field:"optional" json:"securityGroupIdList" yaml:"securityGroupIdList"` // The subnet ID used by the connection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-connection-physicalconnectionrequirements.html#cfn-glue-connection-physicalconnectionrequirements-subnetid // SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"` }
The OAuth client app in GetConnection response.
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"), }
type CfnCrawler ¶
type CfnCrawler interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler. Classifiers() *[]*string SetClassifiers(val *[]*string) // Crawler configuration information. Configuration() *string SetConfiguration(val *string) // The name of the `SecurityConfiguration` structure to be used by this crawler. CrawlerSecurityConfiguration() *string SetCrawlerSecurityConfiguration(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 // The name of the database in which the crawler's output is stored. DatabaseName() *string SetDatabaseName(val *string) // A description of the crawler. Description() *string SetDescription(val *string) // Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials. LakeFormationConfiguration() interface{} SetLakeFormationConfiguration(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 the crawler. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run. RecrawlPolicy() interface{} SetRecrawlPolicy(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 Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data. Role() *string SetRole(val *string) // For scheduled crawlers, the schedule when the crawler runs. Schedule() interface{} SetSchedule(val interface{}) // The policy that specifies update and delete behaviors for the crawler. SchemaChangePolicy() interface{} SetSchemaChangePolicy(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 prefix added to the names of tables that are created. TablePrefix() *string SetTablePrefix(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags to use with this crawler. TagsRaw() interface{} SetTagsRaw(val interface{}) // A collection of targets to crawl. Targets() interface{} SetTargets(val interface{}) // 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::Glue::Crawler` resource specifies an AWS Glue crawler.
For more information, see [Cataloging Tables with a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) and [Crawler Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-crawler-crawling.html#aws-glue-api-crawler-crawling-Crawler) in the *AWS Glue Developer Guide* .
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 tags interface{} cfnCrawler := awscdk.Aws_glue.NewCfnCrawler(this, jsii.String("MyCfnCrawler"), &CfnCrawlerProps{ Role: jsii.String("role"), Targets: &TargetsProperty{ CatalogTargets: []interface{}{ &CatalogTargetProperty{ ConnectionName: jsii.String("connectionName"), DatabaseName: jsii.String("databaseName"), DlqEventQueueArn: jsii.String("dlqEventQueueArn"), EventQueueArn: jsii.String("eventQueueArn"), Tables: []*string{ jsii.String("tables"), }, }, }, DeltaTargets: []interface{}{ &DeltaTargetProperty{ ConnectionName: jsii.String("connectionName"), CreateNativeDeltaTable: jsii.Boolean(false), DeltaTables: []*string{ jsii.String("deltaTables"), }, WriteManifest: jsii.Boolean(false), }, }, DynamoDbTargets: []interface{}{ &DynamoDBTargetProperty{ Path: jsii.String("path"), }, }, IcebergTargets: []interface{}{ &IcebergTargetProperty{ ConnectionName: jsii.String("connectionName"), Exclusions: []*string{ jsii.String("exclusions"), }, MaximumTraversalDepth: jsii.Number(123), Paths: []*string{ jsii.String("paths"), }, }, }, JdbcTargets: []interface{}{ &JdbcTargetProperty{ ConnectionName: jsii.String("connectionName"), EnableAdditionalMetadata: []*string{ jsii.String("enableAdditionalMetadata"), }, Exclusions: []*string{ jsii.String("exclusions"), }, Path: jsii.String("path"), }, }, MongoDbTargets: []interface{}{ &MongoDBTargetProperty{ ConnectionName: jsii.String("connectionName"), Path: jsii.String("path"), }, }, S3Targets: []interface{}{ &S3TargetProperty{ ConnectionName: jsii.String("connectionName"), DlqEventQueueArn: jsii.String("dlqEventQueueArn"), EventQueueArn: jsii.String("eventQueueArn"), Exclusions: []*string{ jsii.String("exclusions"), }, Path: jsii.String("path"), SampleSize: jsii.Number(123), }, }, }, // the properties below are optional Classifiers: []*string{ jsii.String("classifiers"), }, Configuration: jsii.String("configuration"), CrawlerSecurityConfiguration: jsii.String("crawlerSecurityConfiguration"), DatabaseName: jsii.String("databaseName"), Description: jsii.String("description"), LakeFormationConfiguration: &LakeFormationConfigurationProperty{ AccountId: jsii.String("accountId"), UseLakeFormationCredentials: jsii.Boolean(false), }, Name: jsii.String("name"), RecrawlPolicy: &RecrawlPolicyProperty{ RecrawlBehavior: jsii.String("recrawlBehavior"), }, Schedule: &ScheduleProperty{ ScheduleExpression: jsii.String("scheduleExpression"), }, SchemaChangePolicy: &SchemaChangePolicyProperty{ DeleteBehavior: jsii.String("deleteBehavior"), UpdateBehavior: jsii.String("updateBehavior"), }, TablePrefix: jsii.String("tablePrefix"), Tags: tags, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html
func NewCfnCrawler ¶
func NewCfnCrawler(scope constructs.Construct, id *string, props *CfnCrawlerProps) CfnCrawler
type CfnCrawlerProps ¶
type CfnCrawlerProps struct { // The Amazon Resource Name (ARN) of an IAM role that's used to access customer resources, such as Amazon Simple Storage Service (Amazon S3) data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-role // Role *string `field:"required" json:"role" yaml:"role"` // A collection of targets to crawl. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-targets // Targets interface{} `field:"required" json:"targets" yaml:"targets"` // A list of UTF-8 strings that specify the names of custom classifiers that are associated with the crawler. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-classifiers // Classifiers *[]*string `field:"optional" json:"classifiers" yaml:"classifiers"` // Crawler configuration information. // // This versioned JSON string allows users to specify aspects of a crawler's behavior. For more information, see [Configuring a Crawler](https://docs.aws.amazon.com/glue/latest/dg/crawler-configuration.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-configuration // Configuration *string `field:"optional" json:"configuration" yaml:"configuration"` // The name of the `SecurityConfiguration` structure to be used by this crawler. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-crawlersecurityconfiguration // CrawlerSecurityConfiguration *string `field:"optional" json:"crawlerSecurityConfiguration" yaml:"crawlerSecurityConfiguration"` // The name of the database in which the crawler's output is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // A description of the crawler. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-description // Description *string `field:"optional" json:"description" yaml:"description"` // Specifies whether the crawler should use AWS Lake Formation credentials for the crawler instead of the IAM role credentials. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-lakeformationconfiguration // LakeFormationConfiguration interface{} `field:"optional" json:"lakeFormationConfiguration" yaml:"lakeFormationConfiguration"` // The name of the crawler. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-name // Name *string `field:"optional" json:"name" yaml:"name"` // A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-recrawlpolicy // RecrawlPolicy interface{} `field:"optional" json:"recrawlPolicy" yaml:"recrawlPolicy"` // For scheduled crawlers, the schedule when the crawler runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schedule // Schedule interface{} `field:"optional" json:"schedule" yaml:"schedule"` // The policy that specifies update and delete behaviors for the crawler. // // The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl. The `SchemaChangePolicy` does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of the `SchemaChangePolicy` on a crawler. // // The SchemaChangePolicy consists of two components, `UpdateBehavior` and `DeleteBehavior` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-schemachangepolicy // SchemaChangePolicy interface{} `field:"optional" json:"schemaChangePolicy" yaml:"schemaChangePolicy"` // The prefix added to the names of tables that are created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tableprefix // TablePrefix *string `field:"optional" json:"tablePrefix" yaml:"tablePrefix"` // The tags to use with this crawler. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html#cfn-glue-crawler-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnCrawler`.
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 tags interface{} cfnCrawlerProps := &CfnCrawlerProps{ Role: jsii.String("role"), Targets: &TargetsProperty{ CatalogTargets: []interface{}{ &CatalogTargetProperty{ ConnectionName: jsii.String("connectionName"), DatabaseName: jsii.String("databaseName"), DlqEventQueueArn: jsii.String("dlqEventQueueArn"), EventQueueArn: jsii.String("eventQueueArn"), Tables: []*string{ jsii.String("tables"), }, }, }, DeltaTargets: []interface{}{ &DeltaTargetProperty{ ConnectionName: jsii.String("connectionName"), CreateNativeDeltaTable: jsii.Boolean(false), DeltaTables: []*string{ jsii.String("deltaTables"), }, WriteManifest: jsii.Boolean(false), }, }, DynamoDbTargets: []interface{}{ &DynamoDBTargetProperty{ Path: jsii.String("path"), }, }, IcebergTargets: []interface{}{ &IcebergTargetProperty{ ConnectionName: jsii.String("connectionName"), Exclusions: []*string{ jsii.String("exclusions"), }, MaximumTraversalDepth: jsii.Number(123), Paths: []*string{ jsii.String("paths"), }, }, }, JdbcTargets: []interface{}{ &JdbcTargetProperty{ ConnectionName: jsii.String("connectionName"), EnableAdditionalMetadata: []*string{ jsii.String("enableAdditionalMetadata"), }, Exclusions: []*string{ jsii.String("exclusions"), }, Path: jsii.String("path"), }, }, MongoDbTargets: []interface{}{ &MongoDBTargetProperty{ ConnectionName: jsii.String("connectionName"), Path: jsii.String("path"), }, }, S3Targets: []interface{}{ &S3TargetProperty{ ConnectionName: jsii.String("connectionName"), DlqEventQueueArn: jsii.String("dlqEventQueueArn"), EventQueueArn: jsii.String("eventQueueArn"), Exclusions: []*string{ jsii.String("exclusions"), }, Path: jsii.String("path"), SampleSize: jsii.Number(123), }, }, }, // the properties below are optional Classifiers: []*string{ jsii.String("classifiers"), }, Configuration: jsii.String("configuration"), CrawlerSecurityConfiguration: jsii.String("crawlerSecurityConfiguration"), DatabaseName: jsii.String("databaseName"), Description: jsii.String("description"), LakeFormationConfiguration: &LakeFormationConfigurationProperty{ AccountId: jsii.String("accountId"), UseLakeFormationCredentials: jsii.Boolean(false), }, Name: jsii.String("name"), RecrawlPolicy: &RecrawlPolicyProperty{ RecrawlBehavior: jsii.String("recrawlBehavior"), }, Schedule: &ScheduleProperty{ ScheduleExpression: jsii.String("scheduleExpression"), }, SchemaChangePolicy: &SchemaChangePolicyProperty{ DeleteBehavior: jsii.String("deleteBehavior"), UpdateBehavior: jsii.String("updateBehavior"), }, TablePrefix: jsii.String("tablePrefix"), Tags: tags, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-crawler.html
type CfnCrawler_CatalogTargetProperty ¶
type CfnCrawler_CatalogTargetProperty struct { // The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a `Catalog` connection type paired with a `NETWORK` Connection type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-connectionname // ConnectionName *string `field:"optional" json:"connectionName" yaml:"connectionName"` // The name of the database to be synchronized. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // A valid Amazon dead-letter SQS ARN. // // For example, `arn:aws:sqs:region:account:deadLetterQueue` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-dlqeventqueuearn // DlqEventQueueArn *string `field:"optional" json:"dlqEventQueueArn" yaml:"dlqEventQueueArn"` // A valid Amazon SQS ARN. // // For example, `arn:aws:sqs:region:account:sqs` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-eventqueuearn // EventQueueArn *string `field:"optional" json:"eventQueueArn" yaml:"eventQueueArn"` // A list of the tables to be synchronized. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-catalogtarget.html#cfn-glue-crawler-catalogtarget-tables // Tables *[]*string `field:"optional" json:"tables" yaml:"tables"` }
Specifies an AWS Glue Data Catalog target.
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" catalogTargetProperty := &CatalogTargetProperty{ ConnectionName: jsii.String("connectionName"), DatabaseName: jsii.String("databaseName"), DlqEventQueueArn: jsii.String("dlqEventQueueArn"), EventQueueArn: jsii.String("eventQueueArn"), Tables: []*string{ jsii.String("tables"), }, }
type CfnCrawler_DeltaTargetProperty ¶ added in v2.78.0
type CfnCrawler_DeltaTargetProperty struct { // The name of the connection to use to connect to the Delta table target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-connectionname // ConnectionName *string `field:"optional" json:"connectionName" yaml:"connectionName"` // Specifies whether the crawler will create native tables, to allow integration with query engines that support querying of the Delta transaction log directly. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-createnativedeltatable // CreateNativeDeltaTable interface{} `field:"optional" json:"createNativeDeltaTable" yaml:"createNativeDeltaTable"` // A list of the Amazon S3 paths to the Delta tables. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-deltatables // DeltaTables *[]*string `field:"optional" json:"deltaTables" yaml:"deltaTables"` // Specifies whether to write the manifest files to the Delta table path. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-deltatarget.html#cfn-glue-crawler-deltatarget-writemanifest // WriteManifest interface{} `field:"optional" json:"writeManifest" yaml:"writeManifest"` }
Specifies a Delta data store to crawl one or more Delta tables.
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" deltaTargetProperty := &DeltaTargetProperty{ ConnectionName: jsii.String("connectionName"), CreateNativeDeltaTable: jsii.Boolean(false), DeltaTables: []*string{ jsii.String("deltaTables"), }, WriteManifest: jsii.Boolean(false), }
type CfnCrawler_DynamoDBTargetProperty ¶
type CfnCrawler_DynamoDBTargetProperty struct { // The name of the DynamoDB table to crawl. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-dynamodbtarget.html#cfn-glue-crawler-dynamodbtarget-path // Path *string `field:"optional" json:"path" yaml:"path"` }
Specifies an Amazon DynamoDB table to crawl.
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" dynamoDBTargetProperty := &DynamoDBTargetProperty{ Path: jsii.String("path"), }
type CfnCrawler_IcebergTargetProperty ¶ added in v2.91.0
type CfnCrawler_IcebergTargetProperty struct { // The name of the connection to use to connect to the Iceberg target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-connectionname // ConnectionName *string `field:"optional" json:"connectionName" yaml:"connectionName"` // A list of global patterns used to exclude from the crawl. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-exclusions // Exclusions *[]*string `field:"optional" json:"exclusions" yaml:"exclusions"` // The maximum depth of Amazon S3 paths that the crawler can traverse to discover the Iceberg metadata folder in your Amazon S3 path. // // Used to limit the crawler run time. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-maximumtraversaldepth // MaximumTraversalDepth *float64 `field:"optional" json:"maximumTraversalDepth" yaml:"maximumTraversalDepth"` // One or more Amazon S3 paths that contains Iceberg metadata folders as s3://bucket/prefix . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-icebergtarget.html#cfn-glue-crawler-icebergtarget-paths // Paths *[]*string `field:"optional" json:"paths" yaml:"paths"` }
Specifies Apache Iceberg data store targets.
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" icebergTargetProperty := &IcebergTargetProperty{ ConnectionName: jsii.String("connectionName"), Exclusions: []*string{ jsii.String("exclusions"), }, MaximumTraversalDepth: jsii.Number(123), Paths: []*string{ jsii.String("paths"), }, }
type CfnCrawler_JdbcTargetProperty ¶
type CfnCrawler_JdbcTargetProperty struct { // The name of the connection to use to connect to the JDBC target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-connectionname // ConnectionName *string `field:"optional" json:"connectionName" yaml:"connectionName"` // Specify a value of `RAWTYPES` or `COMMENTS` to enable additional metadata in table responses. // // `RAWTYPES` provides the native-level datatype. `COMMENTS` provides comments associated with a column or table in the database. // // If you do not need additional metadata, keep the field empty. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-enableadditionalmetadata // EnableAdditionalMetadata *[]*string `field:"optional" json:"enableAdditionalMetadata" yaml:"enableAdditionalMetadata"` // A list of glob patterns used to exclude from the crawl. // // For more information, see [Catalog Tables with a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-exclusions // Exclusions *[]*string `field:"optional" json:"exclusions" yaml:"exclusions"` // The path of the JDBC target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-jdbctarget.html#cfn-glue-crawler-jdbctarget-path // Path *string `field:"optional" json:"path" yaml:"path"` }
Specifies a JDBC data store to crawl.
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" jdbcTargetProperty := &JdbcTargetProperty{ ConnectionName: jsii.String("connectionName"), EnableAdditionalMetadata: []*string{ jsii.String("enableAdditionalMetadata"), }, Exclusions: []*string{ jsii.String("exclusions"), }, Path: jsii.String("path"), }
type CfnCrawler_LakeFormationConfigurationProperty ¶ added in v2.134.0
type CfnCrawler_LakeFormationConfigurationProperty struct { // Required for cross account crawls. // // For same account crawls as the target data, this can be left as null. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-lakeformationconfiguration.html#cfn-glue-crawler-lakeformationconfiguration-accountid // AccountId *string `field:"optional" json:"accountId" yaml:"accountId"` // Specifies whether to use AWS Lake Formation credentials for the crawler instead of the IAM role credentials. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-lakeformationconfiguration.html#cfn-glue-crawler-lakeformationconfiguration-uselakeformationcredentials // UseLakeFormationCredentials interface{} `field:"optional" json:"useLakeFormationCredentials" yaml:"useLakeFormationCredentials"` }
Specifies AWS Lake Formation configuration settings for the crawler.
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{ AccountId: jsii.String("accountId"), UseLakeFormationCredentials: jsii.Boolean(false), }
type CfnCrawler_MongoDBTargetProperty ¶ added in v2.9.0
type CfnCrawler_MongoDBTargetProperty struct { // The name of the connection to use to connect to the Amazon DocumentDB or MongoDB target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-mongodbtarget.html#cfn-glue-crawler-mongodbtarget-connectionname // ConnectionName *string `field:"optional" json:"connectionName" yaml:"connectionName"` // The path of the Amazon DocumentDB or MongoDB target (database/collection). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-mongodbtarget.html#cfn-glue-crawler-mongodbtarget-path // Path *string `field:"optional" json:"path" yaml:"path"` }
Specifies an Amazon DocumentDB or MongoDB data store to crawl.
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" mongoDBTargetProperty := &MongoDBTargetProperty{ ConnectionName: jsii.String("connectionName"), Path: jsii.String("path"), }
type CfnCrawler_RecrawlPolicyProperty ¶
type CfnCrawler_RecrawlPolicyProperty struct { // Specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run. // // A value of `CRAWL_EVERYTHING` specifies crawling the entire dataset again. // // A value of `CRAWL_NEW_FOLDERS_ONLY` specifies crawling only folders that were added since the last crawler run. // // A value of `CRAWL_EVENT_MODE` specifies crawling only the changes identified by Amazon S3 events. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-recrawlpolicy.html#cfn-glue-crawler-recrawlpolicy-recrawlbehavior // RecrawlBehavior *string `field:"optional" json:"recrawlBehavior" yaml:"recrawlBehavior"` }
When crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.
For more information, see [Incremental Crawls in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/incremental-crawls.html) in the developer guide.
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" recrawlPolicyProperty := &RecrawlPolicyProperty{ RecrawlBehavior: jsii.String("recrawlBehavior"), }
type CfnCrawler_S3TargetProperty ¶
type CfnCrawler_S3TargetProperty struct { // The name of a connection which allows a job or crawler to access data in Amazon S3 within an Amazon Virtual Private Cloud environment (Amazon VPC). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-connectionname // ConnectionName *string `field:"optional" json:"connectionName" yaml:"connectionName"` // A valid Amazon dead-letter SQS ARN. // // For example, `arn:aws:sqs:region:account:deadLetterQueue` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-dlqeventqueuearn // DlqEventQueueArn *string `field:"optional" json:"dlqEventQueueArn" yaml:"dlqEventQueueArn"` // A valid Amazon SQS ARN. // // For example, `arn:aws:sqs:region:account:sqs` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-eventqueuearn // EventQueueArn *string `field:"optional" json:"eventQueueArn" yaml:"eventQueueArn"` // A list of glob patterns used to exclude from the crawl. // // For more information, see [Catalog Tables with a Crawler](https://docs.aws.amazon.com/glue/latest/dg/add-crawler.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-exclusions // Exclusions *[]*string `field:"optional" json:"exclusions" yaml:"exclusions"` // The path to the Amazon S3 target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-path // Path *string `field:"optional" json:"path" yaml:"path"` // Sets the number of files in each leaf folder to be crawled when crawling sample files in a dataset. // // If not set, all the files are crawled. A valid value is an integer between 1 and 249. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-s3target.html#cfn-glue-crawler-s3target-samplesize // SampleSize *float64 `field:"optional" json:"sampleSize" yaml:"sampleSize"` }
Specifies a data store in Amazon Simple Storage Service (Amazon S3).
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" s3TargetProperty := &S3TargetProperty{ ConnectionName: jsii.String("connectionName"), DlqEventQueueArn: jsii.String("dlqEventQueueArn"), EventQueueArn: jsii.String("eventQueueArn"), Exclusions: []*string{ jsii.String("exclusions"), }, Path: jsii.String("path"), SampleSize: jsii.Number(123), }
type CfnCrawler_ScheduleProperty ¶
type CfnCrawler_ScheduleProperty struct { // A `cron` expression used to specify the schedule. // // For more information, see [Time-Based Schedules for Jobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) . For example, to run something every day at 12:15 UTC, specify `cron(15 12 * * ? *)` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schedule.html#cfn-glue-crawler-schedule-scheduleexpression // ScheduleExpression *string `field:"optional" json:"scheduleExpression" yaml:"scheduleExpression"` }
A scheduling object using a `cron` statement to schedule an event.
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" scheduleProperty := &ScheduleProperty{ ScheduleExpression: jsii.String("scheduleExpression"), }
type CfnCrawler_SchemaChangePolicyProperty ¶
type CfnCrawler_SchemaChangePolicyProperty struct { // The deletion behavior when the crawler finds a deleted object. // // A value of `LOG` specifies that if a table or partition is found to no longer exist, do not delete it, only log that it was found to no longer exist. // // A value of `DELETE_FROM_DATABASE` specifies that if a table or partition is found to have been removed, delete it from the database. // // A value of `DEPRECATE_IN_DATABASE` specifies that if a table has been found to no longer exist, to add a property to the table that says "DEPRECATED" and includes a timestamp with the time of deprecation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-deletebehavior // DeleteBehavior *string `field:"optional" json:"deleteBehavior" yaml:"deleteBehavior"` // The update behavior when the crawler finds a changed schema. // // A value of `LOG` specifies that if a table or a partition already exists, and a change is detected, do not update it, only log that a change was detected. Add new tables and new partitions (including on existing tables). // // A value of `UPDATE_IN_DATABASE` specifies that if a table or partition already exists, and a change is detected, update it. Add new tables and partitions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-schemachangepolicy.html#cfn-glue-crawler-schemachangepolicy-updatebehavior // UpdateBehavior *string `field:"optional" json:"updateBehavior" yaml:"updateBehavior"` }
The policy that specifies update and delete behaviors for the crawler.
The policy tells the crawler what to do in the event that it detects a change in a table that already exists in the customer's database at the time of the crawl. The `SchemaChangePolicy` does not affect whether or how new tables and partitions are added. New tables and partitions are always created regardless of the `SchemaChangePolicy` on a crawler.
The SchemaChangePolicy consists of two components, `UpdateBehavior` and `DeleteBehavior` .
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" schemaChangePolicyProperty := &SchemaChangePolicyProperty{ DeleteBehavior: jsii.String("deleteBehavior"), UpdateBehavior: jsii.String("updateBehavior"), }
type CfnCrawler_TargetsProperty ¶
type CfnCrawler_TargetsProperty struct { // Specifies AWS Glue Data Catalog targets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-catalogtargets // CatalogTargets interface{} `field:"optional" json:"catalogTargets" yaml:"catalogTargets"` // Specifies an array of Delta data store targets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-deltatargets // DeltaTargets interface{} `field:"optional" json:"deltaTargets" yaml:"deltaTargets"` // Specifies Amazon DynamoDB targets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-dynamodbtargets // DynamoDbTargets interface{} `field:"optional" json:"dynamoDbTargets" yaml:"dynamoDbTargets"` // Specifies Apache Iceberg data store targets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-icebergtargets // IcebergTargets interface{} `field:"optional" json:"icebergTargets" yaml:"icebergTargets"` // Specifies JDBC targets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-jdbctargets // JdbcTargets interface{} `field:"optional" json:"jdbcTargets" yaml:"jdbcTargets"` // A list of Mongo DB targets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-mongodbtargets // MongoDbTargets interface{} `field:"optional" json:"mongoDbTargets" yaml:"mongoDbTargets"` // Specifies Amazon Simple Storage Service (Amazon S3) targets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-crawler-targets.html#cfn-glue-crawler-targets-s3targets // S3Targets interface{} `field:"optional" json:"s3Targets" yaml:"s3Targets"` }
Specifies data stores to crawl.
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" targetsProperty := &TargetsProperty{ CatalogTargets: []interface{}{ &CatalogTargetProperty{ ConnectionName: jsii.String("connectionName"), DatabaseName: jsii.String("databaseName"), DlqEventQueueArn: jsii.String("dlqEventQueueArn"), EventQueueArn: jsii.String("eventQueueArn"), Tables: []*string{ jsii.String("tables"), }, }, }, DeltaTargets: []interface{}{ &DeltaTargetProperty{ ConnectionName: jsii.String("connectionName"), CreateNativeDeltaTable: jsii.Boolean(false), DeltaTables: []*string{ jsii.String("deltaTables"), }, WriteManifest: jsii.Boolean(false), }, }, DynamoDbTargets: []interface{}{ &DynamoDBTargetProperty{ Path: jsii.String("path"), }, }, IcebergTargets: []interface{}{ &IcebergTargetProperty{ ConnectionName: jsii.String("connectionName"), Exclusions: []*string{ jsii.String("exclusions"), }, MaximumTraversalDepth: jsii.Number(123), Paths: []*string{ jsii.String("paths"), }, }, }, JdbcTargets: []interface{}{ &JdbcTargetProperty{ ConnectionName: jsii.String("connectionName"), EnableAdditionalMetadata: []*string{ jsii.String("enableAdditionalMetadata"), }, Exclusions: []*string{ jsii.String("exclusions"), }, Path: jsii.String("path"), }, }, MongoDbTargets: []interface{}{ &MongoDBTargetProperty{ ConnectionName: jsii.String("connectionName"), Path: jsii.String("path"), }, }, S3Targets: []interface{}{ &S3TargetProperty{ ConnectionName: jsii.String("connectionName"), DlqEventQueueArn: jsii.String("dlqEventQueueArn"), EventQueueArn: jsii.String("eventQueueArn"), Exclusions: []*string{ jsii.String("exclusions"), }, Path: jsii.String("path"), SampleSize: jsii.Number(123), }, }, }
type CfnCustomEntityType ¶ added in v2.119.0
type CfnCustomEntityType interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 AttrId() *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 // A list of context words. ContextWords() *[]*string SetContextWords(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 // 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 // A name for the custom pattern that allows it to be retrieved or deleted later. 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 // A regular expression string that is used for detecting sensitive data in a custom pattern. RegexString() *string SetRegexString(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // AWS tags that contain a key value pair and may be searched by console, command line, or API. Tags() interface{} SetTags(val interface{}) // 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{}) }
Creates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.
Each custom pattern you create specifies a regular expression and an optional list of context words. If no context words are passed only a regular expression is checked.
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 tags interface{} cfnCustomEntityType := awscdk.Aws_glue.NewCfnCustomEntityType(this, jsii.String("MyCfnCustomEntityType"), &CfnCustomEntityTypeProps{ ContextWords: []*string{ jsii.String("contextWords"), }, Name: jsii.String("name"), RegexString: jsii.String("regexString"), Tags: tags, })
func NewCfnCustomEntityType ¶ added in v2.119.0
func NewCfnCustomEntityType(scope constructs.Construct, id *string, props *CfnCustomEntityTypeProps) CfnCustomEntityType
type CfnCustomEntityTypeProps ¶ added in v2.119.0
type CfnCustomEntityTypeProps struct { // A list of context words. // // If none of these context words are found within the vicinity of the regular expression the data will not be detected as sensitive data. // // If no context words are passed only a regular expression is checked. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-customentitytype.html#cfn-glue-customentitytype-contextwords // ContextWords *[]*string `field:"optional" json:"contextWords" yaml:"contextWords"` // A name for the custom pattern that allows it to be retrieved or deleted later. // // This name must be unique per AWS account. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-customentitytype.html#cfn-glue-customentitytype-name // Name *string `field:"optional" json:"name" yaml:"name"` // A regular expression string that is used for detecting sensitive data in a custom pattern. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-customentitytype.html#cfn-glue-customentitytype-regexstring // RegexString *string `field:"optional" json:"regexString" yaml:"regexString"` // AWS tags that contain a key value pair and may be searched by console, command line, or API. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-customentitytype.html#cfn-glue-customentitytype-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnCustomEntityType`.
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 tags interface{} cfnCustomEntityTypeProps := &CfnCustomEntityTypeProps{ ContextWords: []*string{ jsii.String("contextWords"), }, Name: jsii.String("name"), RegexString: jsii.String("regexString"), Tags: tags, }
type CfnDataCatalogEncryptionSettings ¶
type CfnDataCatalogEncryptionSettings interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // The ID of the Data Catalog in which the settings are created. CatalogId() *string SetCatalogId(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 // Contains configuration information for maintaining Data Catalog security. DataCatalogEncryptionSettings() interface{} SetDataCatalogEncryptionSettings(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 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 // 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{}) }
Sets the security configuration for a specified catalog.
After the configuration has been set, the specified encryption is applied to every catalog write thereafter.
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" cfnDataCatalogEncryptionSettings := awscdk.Aws_glue.NewCfnDataCatalogEncryptionSettings(this, jsii.String("MyCfnDataCatalogEncryptionSettings"), &CfnDataCatalogEncryptionSettingsProps{ CatalogId: jsii.String("catalogId"), DataCatalogEncryptionSettings: &DataCatalogEncryptionSettingsProperty{ ConnectionPasswordEncryption: &ConnectionPasswordEncryptionProperty{ KmsKeyId: jsii.String("kmsKeyId"), ReturnConnectionPasswordEncrypted: jsii.Boolean(false), }, EncryptionAtRest: &EncryptionAtRestProperty{ CatalogEncryptionMode: jsii.String("catalogEncryptionMode"), CatalogEncryptionServiceRole: jsii.String("catalogEncryptionServiceRole"), SseAwsKmsKeyId: jsii.String("sseAwsKmsKeyId"), }, }, })
func NewCfnDataCatalogEncryptionSettings ¶
func NewCfnDataCatalogEncryptionSettings(scope constructs.Construct, id *string, props *CfnDataCatalogEncryptionSettingsProps) CfnDataCatalogEncryptionSettings
type CfnDataCatalogEncryptionSettingsProps ¶
type CfnDataCatalogEncryptionSettingsProps struct { // The ID of the Data Catalog in which the settings are created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // Contains configuration information for maintaining Data Catalog security. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-datacatalogencryptionsettings // DataCatalogEncryptionSettings interface{} `field:"required" json:"dataCatalogEncryptionSettings" yaml:"dataCatalogEncryptionSettings"` }
Properties for defining a `CfnDataCatalogEncryptionSettings`.
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" cfnDataCatalogEncryptionSettingsProps := &CfnDataCatalogEncryptionSettingsProps{ CatalogId: jsii.String("catalogId"), DataCatalogEncryptionSettings: &DataCatalogEncryptionSettingsProperty{ ConnectionPasswordEncryption: &ConnectionPasswordEncryptionProperty{ KmsKeyId: jsii.String("kmsKeyId"), ReturnConnectionPasswordEncrypted: jsii.Boolean(false), }, EncryptionAtRest: &EncryptionAtRestProperty{ CatalogEncryptionMode: jsii.String("catalogEncryptionMode"), CatalogEncryptionServiceRole: jsii.String("catalogEncryptionServiceRole"), SseAwsKmsKeyId: jsii.String("sseAwsKmsKeyId"), }, }, }
type CfnDataCatalogEncryptionSettings_ConnectionPasswordEncryptionProperty ¶
type CfnDataCatalogEncryptionSettings_ConnectionPasswordEncryptionProperty struct { // An AWS KMS key that is used to encrypt the connection password. // // If connection password protection is enabled, the caller of `CreateConnection` and `UpdateConnection` needs at least `kms:Encrypt` permission on the specified AWS KMS key, to encrypt passwords before storing them in the Data Catalog. You can set the decrypt permission to enable or restrict access on the password key according to your security requirements. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-connectionpasswordencryption.html#cfn-glue-datacatalogencryptionsettings-connectionpasswordencryption-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` // When the `ReturnConnectionPasswordEncrypted` flag is set to "true", passwords remain encrypted in the responses of `GetConnection` and `GetConnections` . // // This encryption takes effect independently from catalog encryption. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-connectionpasswordencryption.html#cfn-glue-datacatalogencryptionsettings-connectionpasswordencryption-returnconnectionpasswordencrypted // ReturnConnectionPasswordEncrypted interface{} `field:"optional" json:"returnConnectionPasswordEncrypted" yaml:"returnConnectionPasswordEncrypted"` }
The data structure used by the Data Catalog to encrypt the password as part of `CreateConnection` or `UpdateConnection` and store it in the `ENCRYPTED_PASSWORD` field in the connection properties.
You can enable catalog encryption or only password encryption.
When a `CreationConnection` request arrives containing a password, the Data Catalog first encrypts the password using your AWS KMS key. It then encrypts the whole connection object again if catalog encryption is also enabled.
This encryption requires that you set AWS KMS key permissions to enable or restrict access on the password key according to your security requirements. For example, you might want only administrators to have decrypt permission on the password key.
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" connectionPasswordEncryptionProperty := &ConnectionPasswordEncryptionProperty{ KmsKeyId: jsii.String("kmsKeyId"), ReturnConnectionPasswordEncrypted: jsii.Boolean(false), }
type CfnDataCatalogEncryptionSettings_DataCatalogEncryptionSettingsProperty ¶
type CfnDataCatalogEncryptionSettings_DataCatalogEncryptionSettingsProperty struct { // When connection password protection is enabled, the Data Catalog uses a customer-provided key to encrypt the password as part of `CreateConnection` or `UpdateConnection` and store it in the `ENCRYPTED_PASSWORD` field in the connection properties. // // You can enable catalog encryption or only password encryption. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-datacatalogencryptionsettings-connectionpasswordencryption // ConnectionPasswordEncryption interface{} `field:"optional" json:"connectionPasswordEncryption" yaml:"connectionPasswordEncryption"` // Specifies the encryption-at-rest configuration for the Data Catalog. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-datacatalogencryptionsettings.html#cfn-glue-datacatalogencryptionsettings-datacatalogencryptionsettings-encryptionatrest // EncryptionAtRest interface{} `field:"optional" json:"encryptionAtRest" yaml:"encryptionAtRest"` }
Contains configuration information for maintaining Data Catalog security.
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" dataCatalogEncryptionSettingsProperty := &DataCatalogEncryptionSettingsProperty{ ConnectionPasswordEncryption: &ConnectionPasswordEncryptionProperty{ KmsKeyId: jsii.String("kmsKeyId"), ReturnConnectionPasswordEncrypted: jsii.Boolean(false), }, EncryptionAtRest: &EncryptionAtRestProperty{ CatalogEncryptionMode: jsii.String("catalogEncryptionMode"), CatalogEncryptionServiceRole: jsii.String("catalogEncryptionServiceRole"), SseAwsKmsKeyId: jsii.String("sseAwsKmsKeyId"), }, }
type CfnDataCatalogEncryptionSettings_EncryptionAtRestProperty ¶
type CfnDataCatalogEncryptionSettings_EncryptionAtRestProperty struct { // The encryption-at-rest mode for encrypting Data Catalog data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html#cfn-glue-datacatalogencryptionsettings-encryptionatrest-catalogencryptionmode // CatalogEncryptionMode *string `field:"optional" json:"catalogEncryptionMode" yaml:"catalogEncryptionMode"` // The role that AWS Glue assumes to encrypt and decrypt the Data Catalog objects on the caller's behalf. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html#cfn-glue-datacatalogencryptionsettings-encryptionatrest-catalogencryptionservicerole // CatalogEncryptionServiceRole *string `field:"optional" json:"catalogEncryptionServiceRole" yaml:"catalogEncryptionServiceRole"` // The ID of the AWS KMS key to use for encryption at rest. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-datacatalogencryptionsettings-encryptionatrest.html#cfn-glue-datacatalogencryptionsettings-encryptionatrest-sseawskmskeyid // SseAwsKmsKeyId *string `field:"optional" json:"sseAwsKmsKeyId" yaml:"sseAwsKmsKeyId"` }
Specifies the encryption-at-rest configuration for the Data Catalog.
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" encryptionAtRestProperty := &EncryptionAtRestProperty{ CatalogEncryptionMode: jsii.String("catalogEncryptionMode"), CatalogEncryptionServiceRole: jsii.String("catalogEncryptionServiceRole"), SseAwsKmsKeyId: jsii.String("sseAwsKmsKeyId"), }
type CfnDataQualityRuleset ¶ added in v2.86.0
type CfnDataQualityRuleset interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 AttrId() *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 // Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource. ClientToken() *string SetClientToken(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 description of the data quality ruleset. Description() *string SetDescription(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 quality ruleset. 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 // A Data Quality Definition Language (DQDL) ruleset. Ruleset() *string SetRuleset(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A list of tags applied to the data quality ruleset. Tags() interface{} SetTags(val interface{}) // An object representing an AWS Glue table. TargetTable() interface{} SetTargetTable(val interface{}) // 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::Glue::DataQualityRuleset` resource specifies a data quality ruleset with DQDL rules applied to a specified AWS Glue table.
For more information, see AWS Glue Data Quality in the AWS Glue Developer Guide.
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 tags interface{} cfnDataQualityRuleset := awscdk.Aws_glue.NewCfnDataQualityRuleset(this, jsii.String("MyCfnDataQualityRuleset"), &CfnDataQualityRulesetProps{ ClientToken: jsii.String("clientToken"), Description: jsii.String("description"), Name: jsii.String("name"), Ruleset: jsii.String("ruleset"), Tags: tags, TargetTable: &DataQualityTargetTableProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), }, })
func NewCfnDataQualityRuleset ¶ added in v2.86.0
func NewCfnDataQualityRuleset(scope constructs.Construct, id *string, props *CfnDataQualityRulesetProps) CfnDataQualityRuleset
type CfnDataQualityRulesetProps ¶ added in v2.86.0
type CfnDataQualityRulesetProps struct { // Used for idempotency and is recommended to be set to a random ID (such as a UUID) to avoid creating or starting multiple instances of the same resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-clienttoken // ClientToken *string `field:"optional" json:"clientToken" yaml:"clientToken"` // A description of the data quality ruleset. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-description // Description *string `field:"optional" json:"description" yaml:"description"` // The name of the data quality ruleset. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-name // Name *string `field:"optional" json:"name" yaml:"name"` // A Data Quality Definition Language (DQDL) ruleset. // // For more information see the AWS Glue Developer Guide. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-ruleset // Ruleset *string `field:"optional" json:"ruleset" yaml:"ruleset"` // A list of tags applied to the data quality ruleset. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // An object representing an AWS Glue table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-dataqualityruleset.html#cfn-glue-dataqualityruleset-targettable // TargetTable interface{} `field:"optional" json:"targetTable" yaml:"targetTable"` }
Properties for defining a `CfnDataQualityRuleset`.
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 tags interface{} cfnDataQualityRulesetProps := &CfnDataQualityRulesetProps{ ClientToken: jsii.String("clientToken"), Description: jsii.String("description"), Name: jsii.String("name"), Ruleset: jsii.String("ruleset"), Tags: tags, TargetTable: &DataQualityTargetTableProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), }, }
type CfnDataQualityRuleset_DataQualityTargetTableProperty ¶ added in v2.86.0
type CfnDataQualityRuleset_DataQualityTargetTableProperty struct { // The name of the database where the AWS Glue table exists. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-dataqualityruleset-dataqualitytargettable.html#cfn-glue-dataqualityruleset-dataqualitytargettable-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // The name of the AWS Glue table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-dataqualityruleset-dataqualitytargettable.html#cfn-glue-dataqualityruleset-dataqualitytargettable-tablename // TableName *string `field:"optional" json:"tableName" yaml:"tableName"` }
An object representing an AWS Glue table.
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" dataQualityTargetTableProperty := &DataQualityTargetTableProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), }
type CfnDatabase ¶
type CfnDatabase interface { awscdk.CfnResource awscdk.IInspectable // The AWS account ID for the account in which to create the catalog object. CatalogId() *string SetCatalogId(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 metadata for the database. DatabaseInput() interface{} SetDatabaseInput(val interface{}) // The name of the catalog database. DatabaseName() *string SetDatabaseName(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 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 // 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::Glue::Database` resource specifies a logical grouping of tables in AWS Glue .
For more information, see [Defining a Database in Your Data Catalog](https://docs.aws.amazon.com/glue/latest/dg/define-database.html) and [Database Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-databases.html#aws-glue-api-catalog-databases-Database) in the *AWS Glue Developer Guide* .
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 parameters interface{} cfnDatabase := awscdk.Aws_glue.NewCfnDatabase(this, jsii.String("MyCfnDatabase"), &CfnDatabaseProps{ CatalogId: jsii.String("catalogId"), DatabaseInput: &DatabaseInputProperty{ CreateTableDefaultPermissions: []interface{}{ &PrincipalPrivilegesProperty{ Permissions: []*string{ jsii.String("permissions"), }, Principal: &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, }, }, Description: jsii.String("description"), FederatedDatabase: &FederatedDatabaseProperty{ ConnectionName: jsii.String("connectionName"), Identifier: jsii.String("identifier"), }, LocationUri: jsii.String("locationUri"), Name: jsii.String("name"), Parameters: parameters, TargetDatabase: &DatabaseIdentifierProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Region: jsii.String("region"), }, }, // the properties below are optional DatabaseName: jsii.String("databaseName"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html
func NewCfnDatabase ¶
func NewCfnDatabase(scope constructs.Construct, id *string, props *CfnDatabaseProps) CfnDatabase
type CfnDatabaseProps ¶
type CfnDatabaseProps struct { // The AWS account ID for the account in which to create the catalog object. // // > To specify the account ID, you can use the `Ref` intrinsic function with the `AWS::AccountId` pseudo parameter. For example: `!Ref AWS::AccountId` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The metadata for the database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-databaseinput // DatabaseInput interface{} `field:"required" json:"databaseInput" yaml:"databaseInput"` // The name of the catalog database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html#cfn-glue-database-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` }
Properties for defining a `CfnDatabase`.
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 parameters interface{} cfnDatabaseProps := &CfnDatabaseProps{ CatalogId: jsii.String("catalogId"), DatabaseInput: &DatabaseInputProperty{ CreateTableDefaultPermissions: []interface{}{ &PrincipalPrivilegesProperty{ Permissions: []*string{ jsii.String("permissions"), }, Principal: &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, }, }, Description: jsii.String("description"), FederatedDatabase: &FederatedDatabaseProperty{ ConnectionName: jsii.String("connectionName"), Identifier: jsii.String("identifier"), }, LocationUri: jsii.String("locationUri"), Name: jsii.String("name"), Parameters: parameters, TargetDatabase: &DatabaseIdentifierProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Region: jsii.String("region"), }, }, // the properties below are optional DatabaseName: jsii.String("databaseName"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-database.html
type CfnDatabase_DataLakePrincipalProperty ¶
type CfnDatabase_DataLakePrincipalProperty struct { // An identifier for the AWS Lake Formation principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-datalakeprincipal.html#cfn-glue-database-datalakeprincipal-datalakeprincipalidentifier // DataLakePrincipalIdentifier *string `field:"optional" json:"dataLakePrincipalIdentifier" yaml:"dataLakePrincipalIdentifier"` }
The AWS Lake Formation 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" dataLakePrincipalProperty := &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }
type CfnDatabase_DatabaseIdentifierProperty ¶
type CfnDatabase_DatabaseIdentifierProperty struct { // The ID of the Data Catalog in which the database resides. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseidentifier.html#cfn-glue-database-databaseidentifier-catalogid // CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The name of the catalog database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseidentifier.html#cfn-glue-database-databaseidentifier-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // The Region of the database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseidentifier.html#cfn-glue-database-databaseidentifier-region // Region *string `field:"optional" json:"region" yaml:"region"` }
A structure that describes a target database for resource linking.
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" databaseIdentifierProperty := &DatabaseIdentifierProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Region: jsii.String("region"), }
type CfnDatabase_DatabaseInputProperty ¶
type CfnDatabase_DatabaseInputProperty struct { // Creates a set of default permissions on the table for principals. // // Used by AWS Lake Formation . Not used in the normal course of AWS Glue operations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-createtabledefaultpermissions // CreateTableDefaultPermissions interface{} `field:"optional" json:"createTableDefaultPermissions" yaml:"createTableDefaultPermissions"` // A description of the database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-description // Description *string `field:"optional" json:"description" yaml:"description"` // A `FederatedDatabase` structure that references an entity outside the AWS Glue Data Catalog . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-federateddatabase // FederatedDatabase interface{} `field:"optional" json:"federatedDatabase" yaml:"federatedDatabase"` // The location of the database (for example, an HDFS path). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-locationuri // LocationUri *string `field:"optional" json:"locationUri" yaml:"locationUri"` // The name of the database. // // For Hive compatibility, this is folded to lowercase when it is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-name // Name *string `field:"optional" json:"name" yaml:"name"` // These key-value pairs define parameters and properties of the database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // A `DatabaseIdentifier` structure that describes a target database for resource linking. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-databaseinput.html#cfn-glue-database-databaseinput-targetdatabase // TargetDatabase interface{} `field:"optional" json:"targetDatabase" yaml:"targetDatabase"` }
The structure used to create or update a database.
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 parameters interface{} databaseInputProperty := &DatabaseInputProperty{ CreateTableDefaultPermissions: []interface{}{ &PrincipalPrivilegesProperty{ Permissions: []*string{ jsii.String("permissions"), }, Principal: &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, }, }, Description: jsii.String("description"), FederatedDatabase: &FederatedDatabaseProperty{ ConnectionName: jsii.String("connectionName"), Identifier: jsii.String("identifier"), }, LocationUri: jsii.String("locationUri"), Name: jsii.String("name"), Parameters: parameters, TargetDatabase: &DatabaseIdentifierProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Region: jsii.String("region"), }, }
type CfnDatabase_FederatedDatabaseProperty ¶ added in v2.78.0
type CfnDatabase_FederatedDatabaseProperty struct { // The name of the connection to the external metastore. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-federateddatabase.html#cfn-glue-database-federateddatabase-connectionname // ConnectionName *string `field:"optional" json:"connectionName" yaml:"connectionName"` // A unique identifier for the federated database. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-federateddatabase.html#cfn-glue-database-federateddatabase-identifier // Identifier *string `field:"optional" json:"identifier" yaml:"identifier"` }
A `FederatedDatabase` structure that references an entity outside the AWS Glue Data Catalog .
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" federatedDatabaseProperty := &FederatedDatabaseProperty{ ConnectionName: jsii.String("connectionName"), Identifier: jsii.String("identifier"), }
type CfnDatabase_PrincipalPrivilegesProperty ¶
type CfnDatabase_PrincipalPrivilegesProperty struct { // The permissions that are granted to the principal. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html#cfn-glue-database-principalprivileges-permissions // Permissions *[]*string `field:"optional" json:"permissions" yaml:"permissions"` // The principal who is granted permissions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-database-principalprivileges.html#cfn-glue-database-principalprivileges-principal // Principal interface{} `field:"optional" json:"principal" yaml:"principal"` }
the permissions granted to a 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" principalPrivilegesProperty := &PrincipalPrivilegesProperty{ Permissions: []*string{ jsii.String("permissions"), }, Principal: &DataLakePrincipalProperty{ DataLakePrincipalIdentifier: jsii.String("dataLakePrincipalIdentifier"), }, }
type CfnDevEndpoint ¶
type CfnDevEndpoint interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // A map of arguments used to configure the `DevEndpoint` . Arguments() interface{} SetArguments(val interface{}) 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 name of the `DevEndpoint` . EndpointName() *string SetEndpointName(val *string) // The path to one or more Java `.jar` files in an S3 bucket that should be loaded in your `DevEndpoint` . ExtraJarsS3Path() *string SetExtraJarsS3Path(val *string) // The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your `DevEndpoint` . ExtraPythonLibsS3Path() *string SetExtraPythonLibsS3Path(val *string) // The AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports. GlueVersion() *string SetGlueVersion(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 tree node. Node() constructs.Node // The number of AWS Glue Data Processing Units (DPUs) allocated to this `DevEndpoint` . NumberOfNodes() *float64 SetNumberOfNodes(val *float64) // The number of workers of a defined `workerType` that are allocated to the development endpoint. NumberOfWorkers() *float64 SetNumberOfWorkers(val *float64) // The public key to be used by this `DevEndpoint` for authentication. PublicKey() *string SetPublicKey(val *string) // A list of public keys to be used by the `DevEndpoints` for authentication. PublicKeys() *[]*string SetPublicKeys(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 Amazon Resource Name (ARN) of the IAM role used in this `DevEndpoint` . RoleArn() *string SetRoleArn(val *string) // The name of the `SecurityConfiguration` structure to be used with this `DevEndpoint` . SecurityConfiguration() *string SetSecurityConfiguration(val *string) // A list of security group identifiers used in this `DevEndpoint` . SecurityGroupIds() *[]*string SetSecurityGroupIds(val *[]*string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The subnet ID for this `DevEndpoint` . SubnetId() *string SetSubnetId(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags to use with this DevEndpoint. TagsRaw() interface{} SetTagsRaw(val interface{}) // 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 type of predefined worker that is allocated to the development endpoint. WorkerType() *string SetWorkerType(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 `AWS::Glue::DevEndpoint` resource specifies a development endpoint where a developer can remotely debug ETL scripts for AWS Glue .
For more information, see [DevEndpoint Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-dev-endpoint.html#aws-glue-api-jobs-dev-endpoint-DevEndpoint) in the AWS Glue Developer Guide.
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 arguments_ interface{} var tags interface{} cfnDevEndpoint := awscdk.Aws_glue.NewCfnDevEndpoint(this, jsii.String("MyCfnDevEndpoint"), &CfnDevEndpointProps{ RoleArn: jsii.String("roleArn"), // the properties below are optional Arguments: arguments_, EndpointName: jsii.String("endpointName"), ExtraJarsS3Path: jsii.String("extraJarsS3Path"), ExtraPythonLibsS3Path: jsii.String("extraPythonLibsS3Path"), GlueVersion: jsii.String("glueVersion"), NumberOfNodes: jsii.Number(123), NumberOfWorkers: jsii.Number(123), PublicKey: jsii.String("publicKey"), PublicKeys: []*string{ jsii.String("publicKeys"), }, SecurityConfiguration: jsii.String("securityConfiguration"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetId: jsii.String("subnetId"), Tags: tags, WorkerType: jsii.String("workerType"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html
func NewCfnDevEndpoint ¶
func NewCfnDevEndpoint(scope constructs.Construct, id *string, props *CfnDevEndpointProps) CfnDevEndpoint
type CfnDevEndpointProps ¶
type CfnDevEndpointProps struct { // The Amazon Resource Name (ARN) of the IAM role used in this `DevEndpoint` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // A map of arguments used to configure the `DevEndpoint` . // // Valid arguments are: // // - `"--enable-glue-datacatalog": ""` // - `"GLUE_PYTHON_VERSION": "3"` // - `"GLUE_PYTHON_VERSION": "2"` // // You can specify a version of Python support for development endpoints by using the `Arguments` parameter in the `CreateDevEndpoint` or `UpdateDevEndpoint` APIs. If no arguments are provided, the version defaults to Python 2. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-arguments // Arguments interface{} `field:"optional" json:"arguments" yaml:"arguments"` // The name of the `DevEndpoint` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-endpointname // EndpointName *string `field:"optional" json:"endpointName" yaml:"endpointName"` // The path to one or more Java `.jar` files in an S3 bucket that should be loaded in your `DevEndpoint` . // // > You can only use pure Java/Scala libraries with a `DevEndpoint` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrajarss3path // ExtraJarsS3Path *string `field:"optional" json:"extraJarsS3Path" yaml:"extraJarsS3Path"` // The paths to one or more Python libraries in an Amazon S3 bucket that should be loaded in your `DevEndpoint` . // // Multiple values must be complete paths separated by a comma. // // > You can only use pure Python libraries with a `DevEndpoint` . Libraries that rely on C extensions, such as the [pandas](https://docs.aws.amazon.com/http://pandas.pydata.org/) Python data analysis library, are not currently supported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-extrapythonlibss3path // ExtraPythonLibsS3Path *string `field:"optional" json:"extraPythonLibsS3Path" yaml:"extraPythonLibsS3Path"` // The AWS Glue version determines the versions of Apache Spark and Python that AWS Glue supports. // // The Python version indicates the version supported for running your ETL scripts on development endpoints. // // For more information about the available AWS Glue versions and corresponding Spark and Python versions, see [Glue version](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer guide. // // Development endpoints that are created without specifying a Glue version default to Glue 0.9. // // You can specify a version of Python support for development endpoints by using the `Arguments` parameter in the `CreateDevEndpoint` or `UpdateDevEndpoint` APIs. If no arguments are provided, the version defaults to Python 2. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-glueversion // GlueVersion *string `field:"optional" json:"glueVersion" yaml:"glueVersion"` // The number of AWS Glue Data Processing Units (DPUs) allocated to this `DevEndpoint` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofnodes // NumberOfNodes *float64 `field:"optional" json:"numberOfNodes" yaml:"numberOfNodes"` // The number of workers of a defined `workerType` that are allocated to the development endpoint. // // The maximum number of workers you can define are 299 for `G.1X` , and 149 for `G.2X` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-numberofworkers // NumberOfWorkers *float64 `field:"optional" json:"numberOfWorkers" yaml:"numberOfWorkers"` // The public key to be used by this `DevEndpoint` for authentication. // // This attribute is provided for backward compatibility because the recommended attribute to use is public keys. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-publickey // PublicKey *string `field:"optional" json:"publicKey" yaml:"publicKey"` // A list of public keys to be used by the `DevEndpoints` for authentication. // // Using this attribute is preferred over a single public key because the public keys allow you to have a different private key per client. // // > If you previously created an endpoint with a public key, you must remove that key to be able to set a list of public keys. Call the `UpdateDevEndpoint` API operation with the public key content in the `deletePublicKeys` attribute, and the list of new keys in the `addPublicKeys` attribute. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-publickeys // PublicKeys *[]*string `field:"optional" json:"publicKeys" yaml:"publicKeys"` // The name of the `SecurityConfiguration` structure to be used with this `DevEndpoint` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-securityconfiguration // SecurityConfiguration *string `field:"optional" json:"securityConfiguration" yaml:"securityConfiguration"` // A list of security group identifiers used in this `DevEndpoint` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-securitygroupids // SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"` // The subnet ID for this `DevEndpoint` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-subnetid // SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"` // The tags to use with this DevEndpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // The type of predefined worker that is allocated to the development endpoint. // // Accepts a value of Standard, G.1X, or G.2X. // // - For the `Standard` worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. // - For the `G.1X` worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. // - For the `G.2X` worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. // // Known issue: when a development endpoint is created with the `G.2X` `WorkerType` configuration, the Spark drivers for the development endpoint will run on 4 vCPU, 16 GB of memory, and a 64 GB disk. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html#cfn-glue-devendpoint-workertype // WorkerType *string `field:"optional" json:"workerType" yaml:"workerType"` }
Properties for defining a `CfnDevEndpoint`.
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 arguments_ interface{} var tags interface{} cfnDevEndpointProps := &CfnDevEndpointProps{ RoleArn: jsii.String("roleArn"), // the properties below are optional Arguments: arguments_, EndpointName: jsii.String("endpointName"), ExtraJarsS3Path: jsii.String("extraJarsS3Path"), ExtraPythonLibsS3Path: jsii.String("extraPythonLibsS3Path"), GlueVersion: jsii.String("glueVersion"), NumberOfNodes: jsii.Number(123), NumberOfWorkers: jsii.Number(123), PublicKey: jsii.String("publicKey"), PublicKeys: []*string{ jsii.String("publicKeys"), }, SecurityConfiguration: jsii.String("securityConfiguration"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetId: jsii.String("subnetId"), Tags: tags, WorkerType: jsii.String("workerType"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-devendpoint.html
type CfnJob ¶
type CfnJob interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // This parameter is no longer supported. // // Use `MaxCapacity` instead. AllocatedCapacity() *float64 SetAllocatedCapacity(val *float64) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The code that executes a job. Command() interface{} SetCommand(val interface{}) // The connections used for this job. Connections() interface{} SetConnections(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The default arguments for this job, specified as name-value pairs. DefaultArguments() interface{} SetDefaultArguments(val interface{}) // A description of the job. Description() *string SetDescription(val *string) // Indicates whether the job is run with a standard or flexible execution class. ExecutionClass() *string SetExecutionClass(val *string) // The maximum number of concurrent runs that are allowed for this job. ExecutionProperty() interface{} SetExecutionProperty(val interface{}) // Glue version determines the versions of Apache Spark and Python that AWS Glue supports. GlueVersion() *string SetGlueVersion(val *string) // A mode that describes how a job was created. // // Valid values are:. JobMode() *string SetJobMode(val *string) // Specifies whether job run queuing is enabled for the job runs for this job. JobRunQueuingEnabled() interface{} SetJobRunQueuingEnabled(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 // This field is reserved for future use. LogUri() *string SetLogUri(val *string) // This field specifies a day of the week and hour for a maintenance window for streaming jobs. MaintenanceWindow() *string SetMaintenanceWindow(val *string) // The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. MaxCapacity() *float64 SetMaxCapacity(val *float64) // The maximum number of times to retry this job after a JobRun fails. MaxRetries() *float64 SetMaxRetries(val *float64) // The name you assign to this job definition. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Non-overridable arguments for this job, specified as name-value pairs. NonOverridableArguments() interface{} SetNonOverridableArguments(val interface{}) // Specifies configuration properties of a notification. NotificationProperty() interface{} SetNotificationProperty(val interface{}) // The number of workers of a defined `workerType` that are allocated when a job runs. NumberOfWorkers() *float64 SetNumberOfWorkers(val *float64) // 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 name or Amazon Resource Name (ARN) of the IAM role associated with this job. Role() *string SetRole(val *string) // The name of the `SecurityConfiguration` structure to be used with this job. SecurityConfiguration() *string SetSecurityConfiguration(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags to use with this job. TagsRaw() interface{} SetTagsRaw(val interface{}) // The job timeout in minutes. Timeout() *float64 SetTimeout(val *float64) // 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 type of predefined worker that is allocated when a job runs. WorkerType() *string SetWorkerType(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 `AWS::Glue::Job` resource specifies an AWS Glue job in the data catalog.
For more information, see [Adding Jobs in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) and [Job Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job) in the *AWS Glue Developer Guide.*
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 defaultArguments interface{} var nonOverridableArguments interface{} var tags interface{} cfnJob := awscdk.Aws_glue.NewCfnJob(this, jsii.String("MyCfnJob"), &CfnJobProps{ Command: &JobCommandProperty{ Name: jsii.String("name"), PythonVersion: jsii.String("pythonVersion"), Runtime: jsii.String("runtime"), ScriptLocation: jsii.String("scriptLocation"), }, Role: jsii.String("role"), // the properties below are optional AllocatedCapacity: jsii.Number(123), Connections: &ConnectionsListProperty{ Connections: []*string{ jsii.String("connections"), }, }, DefaultArguments: defaultArguments, Description: jsii.String("description"), ExecutionClass: jsii.String("executionClass"), ExecutionProperty: &ExecutionPropertyProperty{ MaxConcurrentRuns: jsii.Number(123), }, GlueVersion: jsii.String("glueVersion"), JobMode: jsii.String("jobMode"), JobRunQueuingEnabled: jsii.Boolean(false), LogUri: jsii.String("logUri"), MaintenanceWindow: jsii.String("maintenanceWindow"), MaxCapacity: jsii.Number(123), MaxRetries: jsii.Number(123), Name: jsii.String("name"), NonOverridableArguments: nonOverridableArguments, NotificationProperty: &NotificationPropertyProperty{ NotifyDelayAfter: jsii.Number(123), }, NumberOfWorkers: jsii.Number(123), SecurityConfiguration: jsii.String("securityConfiguration"), Tags: tags, Timeout: jsii.Number(123), WorkerType: jsii.String("workerType"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html
func NewCfnJob ¶
func NewCfnJob(scope constructs.Construct, id *string, props *CfnJobProps) CfnJob
type CfnJobProps ¶
type CfnJobProps struct { // The code that executes a job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-command // Command interface{} `field:"required" json:"command" yaml:"command"` // The name or Amazon Resource Name (ARN) of the IAM role associated with this job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-role // Role *string `field:"required" json:"role" yaml:"role"` // This parameter is no longer supported. Use `MaxCapacity` instead. // // The number of capacity units that are allocated to this job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-allocatedcapacity // AllocatedCapacity *float64 `field:"optional" json:"allocatedCapacity" yaml:"allocatedCapacity"` // The connections used for this job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-connections // Connections interface{} `field:"optional" json:"connections" yaml:"connections"` // The default arguments for this job, specified as name-value pairs. // // You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes. // // For information about how to specify and consume your own job arguments, see [Calling AWS Glue APIs in Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) in the *AWS Glue Developer Guide* . // // For information about the key-value pairs that AWS Glue consumes to set up your job, see [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) in the *AWS Glue Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-defaultarguments // DefaultArguments interface{} `field:"optional" json:"defaultArguments" yaml:"defaultArguments"` // A description of the job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-description // Description *string `field:"optional" json:"description" yaml:"description"` // Indicates whether the job is run with a standard or flexible execution class. // // The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources. // // The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary. // // Only jobs with AWS Glue version 3.0 and above and command type `glueetl` will be allowed to set `ExecutionClass` to `FLEX` . The flexible execution class is available for Spark jobs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-executionclass // ExecutionClass *string `field:"optional" json:"executionClass" yaml:"executionClass"` // The maximum number of concurrent runs that are allowed for this job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-executionproperty // ExecutionProperty interface{} `field:"optional" json:"executionProperty" yaml:"executionProperty"` // Glue version determines the versions of Apache Spark and Python that AWS Glue supports. // // The Python version indicates the version supported for jobs of type Spark. // // For more information about the available AWS Glue versions and corresponding Spark and Python versions, see [Glue version](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer guide. // // Jobs that are created without specifying a Glue version default to the latest Glue version available. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-glueversion // GlueVersion *string `field:"optional" json:"glueVersion" yaml:"glueVersion"` // A mode that describes how a job was created. Valid values are:. // // - `SCRIPT` - The job was created using the AWS Glue Studio script editor. // - `VISUAL` - The job was created using the AWS Glue Studio visual editor. // - `NOTEBOOK` - The job was created using an interactive sessions notebook. // // When the `JobMode` field is missing or null, `SCRIPT` is assigned as the default value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-jobmode // JobMode *string `field:"optional" json:"jobMode" yaml:"jobMode"` // Specifies whether job run queuing is enabled for the job runs for this job. // // A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing. // // If this field does not match the value set in the job run, then the value from the job run field will be used. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-jobrunqueuingenabled // JobRunQueuingEnabled interface{} `field:"optional" json:"jobRunQueuingEnabled" yaml:"jobRunQueuingEnabled"` // This field is reserved for future use. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-loguri // LogUri *string `field:"optional" json:"logUri" yaml:"logUri"` // This field specifies a day of the week and hour for a maintenance window for streaming jobs. // // AWS Glue periodically performs maintenance activities. During these maintenance windows, AWS Glue will need to restart your streaming jobs. // // AWS Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maintenancewindow // MaintenanceWindow *string `field:"optional" json:"maintenanceWindow" yaml:"maintenanceWindow"` // The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. // // A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. // // Do not set `Max Capacity` if using `WorkerType` and `NumberOfWorkers` . // // The value that can be allocated for `MaxCapacity` depends on whether you are running a Python shell job or an Apache Spark ETL job: // // - When you specify a Python shell job ( `JobCommand.Name` ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. // - When you specify an Apache Spark ETL job ( `JobCommand.Name` ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maxcapacity // MaxCapacity *float64 `field:"optional" json:"maxCapacity" yaml:"maxCapacity"` // The maximum number of times to retry this job after a JobRun fails. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-maxretries // MaxRetries *float64 `field:"optional" json:"maxRetries" yaml:"maxRetries"` // The name you assign to this job definition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-name // Name *string `field:"optional" json:"name" yaml:"name"` // Non-overridable arguments for this job, specified as name-value pairs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-nonoverridablearguments // NonOverridableArguments interface{} `field:"optional" json:"nonOverridableArguments" yaml:"nonOverridableArguments"` // Specifies configuration properties of a notification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-notificationproperty // NotificationProperty interface{} `field:"optional" json:"notificationProperty" yaml:"notificationProperty"` // The number of workers of a defined `workerType` that are allocated when a job runs. // // The maximum number of workers you can define are 299 for `G.1X` , and 149 for `G.2X` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-numberofworkers // NumberOfWorkers *float64 `field:"optional" json:"numberOfWorkers" yaml:"numberOfWorkers"` // The name of the `SecurityConfiguration` structure to be used with this job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-securityconfiguration // SecurityConfiguration *string `field:"optional" json:"securityConfiguration" yaml:"securityConfiguration"` // The tags to use with this job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // The job timeout in minutes. // // This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-timeout // Timeout *float64 `field:"optional" json:"timeout" yaml:"timeout"` // The type of predefined worker that is allocated when a job runs. // // Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs. // // - For the `G.1X` worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. // - For the `G.2X` worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. // - For the `G.4X` worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs in the following AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). // - For the `G.8X` worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs, in the same AWS Regions as supported for the `G.4X` worker type. // - For the `G.025X` worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for AWS Glue version 3.0 streaming jobs. // - For the `Z.2X` worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html#cfn-glue-job-workertype // WorkerType *string `field:"optional" json:"workerType" yaml:"workerType"` }
Properties for defining a `CfnJob`.
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 defaultArguments interface{} var nonOverridableArguments interface{} var tags interface{} cfnJobProps := &CfnJobProps{ Command: &JobCommandProperty{ Name: jsii.String("name"), PythonVersion: jsii.String("pythonVersion"), Runtime: jsii.String("runtime"), ScriptLocation: jsii.String("scriptLocation"), }, Role: jsii.String("role"), // the properties below are optional AllocatedCapacity: jsii.Number(123), Connections: &ConnectionsListProperty{ Connections: []*string{ jsii.String("connections"), }, }, DefaultArguments: defaultArguments, Description: jsii.String("description"), ExecutionClass: jsii.String("executionClass"), ExecutionProperty: &ExecutionPropertyProperty{ MaxConcurrentRuns: jsii.Number(123), }, GlueVersion: jsii.String("glueVersion"), JobMode: jsii.String("jobMode"), JobRunQueuingEnabled: jsii.Boolean(false), LogUri: jsii.String("logUri"), MaintenanceWindow: jsii.String("maintenanceWindow"), MaxCapacity: jsii.Number(123), MaxRetries: jsii.Number(123), Name: jsii.String("name"), NonOverridableArguments: nonOverridableArguments, NotificationProperty: &NotificationPropertyProperty{ NotifyDelayAfter: jsii.Number(123), }, NumberOfWorkers: jsii.Number(123), SecurityConfiguration: jsii.String("securityConfiguration"), Tags: tags, Timeout: jsii.Number(123), WorkerType: jsii.String("workerType"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-job.html
type CfnJob_ConnectionsListProperty ¶
type CfnJob_ConnectionsListProperty struct { // A list of connections used by the job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-connectionslist.html#cfn-glue-job-connectionslist-connections // Connections *[]*string `field:"optional" json:"connections" yaml:"connections"` }
Specifies the connections used by a job.
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" connectionsListProperty := &ConnectionsListProperty{ Connections: []*string{ jsii.String("connections"), }, }
type CfnJob_ExecutionPropertyProperty ¶
type CfnJob_ExecutionPropertyProperty struct { // The maximum number of concurrent runs allowed for the job. // // The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-executionproperty.html#cfn-glue-job-executionproperty-maxconcurrentruns // MaxConcurrentRuns *float64 `field:"optional" json:"maxConcurrentRuns" yaml:"maxConcurrentRuns"` }
An execution property of a job.
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" executionPropertyProperty := &ExecutionPropertyProperty{ MaxConcurrentRuns: jsii.Number(123), }
type CfnJob_JobCommandProperty ¶
type CfnJob_JobCommandProperty struct { // The name of the job command. // // For an Apache Spark ETL job, this must be `glueetl` . For a Python shell job, it must be `pythonshell` . For an Apache Spark streaming ETL job, this must be `gluestreaming` . For a Ray job, this must be `glueray` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-name // Name *string `field:"optional" json:"name" yaml:"name"` // The Python version being used to execute a Python shell job. // // Allowed values are 3 or 3.9. Version 2 is deprecated. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-pythonversion // PythonVersion *string `field:"optional" json:"pythonVersion" yaml:"pythonVersion"` // In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. // // This field is not used in other job types. For supported runtime environment values, see [Working with Ray jobs](https://docs.aws.amazon.com/glue/latest/dg/ray-jobs-section.html) in the AWS Glue Developer Guide. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-runtime // Runtime *string `field:"optional" json:"runtime" yaml:"runtime"` // Specifies the Amazon Simple Storage Service (Amazon S3) path to a script that executes a job (required). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-jobcommand.html#cfn-glue-job-jobcommand-scriptlocation // ScriptLocation *string `field:"optional" json:"scriptLocation" yaml:"scriptLocation"` }
Specifies code executed when a job is 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" jobCommandProperty := &JobCommandProperty{ Name: jsii.String("name"), PythonVersion: jsii.String("pythonVersion"), Runtime: jsii.String("runtime"), ScriptLocation: jsii.String("scriptLocation"), }
type CfnJob_NotificationPropertyProperty ¶
type CfnJob_NotificationPropertyProperty struct { // After a job run starts, the number of minutes to wait before sending a job run delay notification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-job-notificationproperty.html#cfn-glue-job-notificationproperty-notifydelayafter // NotifyDelayAfter *float64 `field:"optional" json:"notifyDelayAfter" yaml:"notifyDelayAfter"` }
Specifies configuration properties of a notification.
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" notificationPropertyProperty := &NotificationPropertyProperty{ NotifyDelayAfter: jsii.Number(123), }
type CfnMLTransform ¶
type CfnMLTransform interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable 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 // A user-defined, long-form description text for the machine learning transform. Description() *string SetDescription(val *string) // This value determines which version of AWS Glue this machine learning transform is compatible with. GlueVersion() *string SetGlueVersion(val *string) // A list of AWS Glue table definitions used by the transform. InputRecordTables() interface{} SetInputRecordTables(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 number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. MaxCapacity() *float64 SetMaxCapacity(val *float64) // The maximum number of times to retry after an `MLTaskRun` of the machine learning transform fails. MaxRetries() *float64 SetMaxRetries(val *float64) // A user-defined name for the machine learning transform. // // Names are required to be unique. `Name` is optional:. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The number of workers of a defined `workerType` that are allocated when a task of the transform runs. NumberOfWorkers() *float64 SetNumberOfWorkers(val *float64) // 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 name or Amazon Resource Name (ARN) of the IAM role with the required permissions. Role() *string SetRole(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags to use with this machine learning transform. TagsRaw() interface{} SetTagsRaw(val interface{}) // The timeout in minutes of the machine learning transform. Timeout() *float64 SetTimeout(val *float64) // The encryption-at-rest settings of the transform that apply to accessing user data. TransformEncryption() interface{} SetTransformEncryption(val interface{}) // The algorithm-specific parameters that are associated with the machine learning transform. TransformParameters() interface{} SetTransformParameters(val interface{}) // 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 type of predefined worker that is allocated when a task of this transform runs. WorkerType() *string SetWorkerType(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 AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms.
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 tags interface{} cfnMLTransform := awscdk.Aws_glue.NewCfnMLTransform(this, jsii.String("MyCfnMLTransform"), &CfnMLTransformProps{ InputRecordTables: &InputRecordTablesProperty{ GlueTables: []interface{}{ &GlueTablesProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), ConnectionName: jsii.String("connectionName"), }, }, }, Role: jsii.String("role"), TransformParameters: &TransformParametersProperty{ TransformType: jsii.String("transformType"), // the properties below are optional FindMatchesParameters: &FindMatchesParametersProperty{ PrimaryKeyColumnName: jsii.String("primaryKeyColumnName"), // the properties below are optional AccuracyCostTradeoff: jsii.Number(123), EnforceProvidedLabels: jsii.Boolean(false), PrecisionRecallTradeoff: jsii.Number(123), }, }, // the properties below are optional Description: jsii.String("description"), GlueVersion: jsii.String("glueVersion"), MaxCapacity: jsii.Number(123), MaxRetries: jsii.Number(123), Name: jsii.String("name"), NumberOfWorkers: jsii.Number(123), Tags: tags, Timeout: jsii.Number(123), TransformEncryption: &TransformEncryptionProperty{ MlUserDataEncryption: &MLUserDataEncryptionProperty{ MlUserDataEncryptionMode: jsii.String("mlUserDataEncryptionMode"), // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, TaskRunSecurityConfigurationName: jsii.String("taskRunSecurityConfigurationName"), }, WorkerType: jsii.String("workerType"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html
func NewCfnMLTransform ¶
func NewCfnMLTransform(scope constructs.Construct, id *string, props *CfnMLTransformProps) CfnMLTransform
type CfnMLTransformProps ¶
type CfnMLTransformProps struct { // A list of AWS Glue table definitions used by the transform. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-inputrecordtables // InputRecordTables interface{} `field:"required" json:"inputRecordTables" yaml:"inputRecordTables"` // The name or Amazon Resource Name (ARN) of the IAM role with the required permissions. // // The required permissions include both AWS Glue service role permissions to AWS Glue resources, and Amazon S3 permissions required by the transform. // // - This role needs AWS Glue service role permissions to allow access to resources in AWS Glue . See [Attach a Policy to IAM Users That Access AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/attach-policy-iam-user.html) . // - This role needs permission to your Amazon Simple Storage Service (Amazon S3) sources, targets, temporary directory, scripts, and any libraries used by the task run for this transform. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-role // Role *string `field:"required" json:"role" yaml:"role"` // The algorithm-specific parameters that are associated with the machine learning transform. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-transformparameters // TransformParameters interface{} `field:"required" json:"transformParameters" yaml:"transformParameters"` // A user-defined, long-form description text for the machine learning transform. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-description // Description *string `field:"optional" json:"description" yaml:"description"` // This value determines which version of AWS Glue this machine learning transform is compatible with. // // Glue 1.0 is recommended for most customers. If the value is not set, the Glue compatibility defaults to Glue 0.9. For more information, see [AWS Glue Versions](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html#release-notes-versions) in the developer guide. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-glueversion // GlueVersion *string `field:"optional" json:"glueVersion" yaml:"glueVersion"` // The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. // // You can allocate from 2 to 100 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the [AWS Glue pricing page](https://docs.aws.amazon.com/glue/pricing/) . // // `MaxCapacity` is a mutually exclusive option with `NumberOfWorkers` and `WorkerType` . // // - If either `NumberOfWorkers` or `WorkerType` is set, then `MaxCapacity` cannot be set. // - If `MaxCapacity` is set then neither `NumberOfWorkers` or `WorkerType` can be set. // - If `WorkerType` is set, then `NumberOfWorkers` is required (and vice versa). // - `MaxCapacity` and `NumberOfWorkers` must both be at least 1. // // When the `WorkerType` field is set to a value other than `Standard` , the `MaxCapacity` field is set automatically and becomes read-only. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-maxcapacity // MaxCapacity *float64 `field:"optional" json:"maxCapacity" yaml:"maxCapacity"` // The maximum number of times to retry after an `MLTaskRun` of the machine learning transform fails. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-maxretries // MaxRetries *float64 `field:"optional" json:"maxRetries" yaml:"maxRetries"` // A user-defined name for the machine learning transform. Names are required to be unique. `Name` is optional:. // // - If you supply `Name` , the stack cannot be repeatedly created. // - If `Name` is not provided, a randomly generated name will be used instead. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-name // Name *string `field:"optional" json:"name" yaml:"name"` // The number of workers of a defined `workerType` that are allocated when a task of the transform runs. // // If `WorkerType` is set, then `NumberOfWorkers` is required (and vice versa). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-numberofworkers // NumberOfWorkers *float64 `field:"optional" json:"numberOfWorkers" yaml:"numberOfWorkers"` // The tags to use with this machine learning transform. // // You may use tags to limit access to the machine learning transform. For more information about tags in AWS Glue , see [AWS Tags in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/monitor-tags.html) in the developer guide. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // The timeout in minutes of the machine learning transform. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-timeout // Timeout *float64 `field:"optional" json:"timeout" yaml:"timeout"` // The encryption-at-rest settings of the transform that apply to accessing user data. // // Machine learning // transforms can access user data encrypted in Amazon S3 using KMS. // // Additionally, imported labels and trained transforms can now be encrypted using a customer provided // KMS key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-transformencryption // TransformEncryption interface{} `field:"optional" json:"transformEncryption" yaml:"transformEncryption"` // The type of predefined worker that is allocated when a task of this transform runs. // // Accepts a value of Standard, G.1X, or G.2X. // // - For the `Standard` worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. // - For the `G.1X` worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker. // - For the `G.2X` worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker. // // `MaxCapacity` is a mutually exclusive option with `NumberOfWorkers` and `WorkerType` . // // - If either `NumberOfWorkers` or `WorkerType` is set, then `MaxCapacity` cannot be set. // - If `MaxCapacity` is set then neither `NumberOfWorkers` or `WorkerType` can be set. // - If `WorkerType` is set, then `NumberOfWorkers` is required (and vice versa). // - `MaxCapacity` and `NumberOfWorkers` must both be at least 1. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html#cfn-glue-mltransform-workertype // WorkerType *string `field:"optional" json:"workerType" yaml:"workerType"` }
Properties for defining a `CfnMLTransform`.
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 tags interface{} cfnMLTransformProps := &CfnMLTransformProps{ InputRecordTables: &InputRecordTablesProperty{ GlueTables: []interface{}{ &GlueTablesProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), ConnectionName: jsii.String("connectionName"), }, }, }, Role: jsii.String("role"), TransformParameters: &TransformParametersProperty{ TransformType: jsii.String("transformType"), // the properties below are optional FindMatchesParameters: &FindMatchesParametersProperty{ PrimaryKeyColumnName: jsii.String("primaryKeyColumnName"), // the properties below are optional AccuracyCostTradeoff: jsii.Number(123), EnforceProvidedLabels: jsii.Boolean(false), PrecisionRecallTradeoff: jsii.Number(123), }, }, // the properties below are optional Description: jsii.String("description"), GlueVersion: jsii.String("glueVersion"), MaxCapacity: jsii.Number(123), MaxRetries: jsii.Number(123), Name: jsii.String("name"), NumberOfWorkers: jsii.Number(123), Tags: tags, Timeout: jsii.Number(123), TransformEncryption: &TransformEncryptionProperty{ MlUserDataEncryption: &MLUserDataEncryptionProperty{ MlUserDataEncryptionMode: jsii.String("mlUserDataEncryptionMode"), // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, TaskRunSecurityConfigurationName: jsii.String("taskRunSecurityConfigurationName"), }, WorkerType: jsii.String("workerType"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-mltransform.html
type CfnMLTransform_FindMatchesParametersProperty ¶
type CfnMLTransform_FindMatchesParametersProperty struct { // The name of a column that uniquely identifies rows in the source table. // // Used to help identify matching records. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-findmatchesparameters.html#cfn-glue-mltransform-findmatchesparameters-primarykeycolumnname // PrimaryKeyColumnName *string `field:"required" json:"primaryKeyColumnName" yaml:"primaryKeyColumnName"` // The value that is selected when tuning your transform for a balance between accuracy and cost. // // A value of 0.5 means that the system balances accuracy and cost concerns. A value of 1.0 means a bias purely for accuracy, which typically results in a higher cost, sometimes substantially higher. A value of 0.0 means a bias purely for cost, which results in a less accurate `FindMatches` transform, sometimes with unacceptable accuracy. // // Accuracy measures how well the transform finds true positives and true negatives. Increasing accuracy requires more machine resources and cost. But it also results in increased recall. // // Cost measures how many compute resources, and thus money, are consumed to run the transform. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-findmatchesparameters.html#cfn-glue-mltransform-findmatchesparameters-accuracycosttradeoff // AccuracyCostTradeoff *float64 `field:"optional" json:"accuracyCostTradeoff" yaml:"accuracyCostTradeoff"` // The value to switch on or off to force the output to match the provided labels from users. // // If the value is `True` , the `find matches` transform forces the output to match the provided labels. The results override the normal conflation results. If the value is `False` , the `find matches` transform does not ensure all the labels provided are respected, and the results rely on the trained model. // // Note that setting this value to true may increase the conflation execution time. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-findmatchesparameters.html#cfn-glue-mltransform-findmatchesparameters-enforceprovidedlabels // EnforceProvidedLabels interface{} `field:"optional" json:"enforceProvidedLabels" yaml:"enforceProvidedLabels"` // The value selected when tuning your transform for a balance between precision and recall. // // A value of 0.5 means no preference; a value of 1.0 means a bias purely for precision, and a value of 0.0 means a bias for recall. Because this is a tradeoff, choosing values close to 1.0 means very low recall, and choosing values close to 0.0 results in very low precision. // // The precision metric indicates how often your model is correct when it predicts a match. // // The recall metric indicates that for an actual match, how often your model predicts the match. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-findmatchesparameters.html#cfn-glue-mltransform-findmatchesparameters-precisionrecalltradeoff // PrecisionRecallTradeoff *float64 `field:"optional" json:"precisionRecallTradeoff" yaml:"precisionRecallTradeoff"` }
The parameters to configure the find matches transform.
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" findMatchesParametersProperty := &FindMatchesParametersProperty{ PrimaryKeyColumnName: jsii.String("primaryKeyColumnName"), // the properties below are optional AccuracyCostTradeoff: jsii.Number(123), EnforceProvidedLabels: jsii.Boolean(false), PrecisionRecallTradeoff: jsii.Number(123), }
type CfnMLTransform_GlueTablesProperty ¶
type CfnMLTransform_GlueTablesProperty struct { // A database name in the AWS Glue Data Catalog . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-gluetables.html#cfn-glue-mltransform-gluetables-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // A table name in the AWS Glue Data Catalog . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-gluetables.html#cfn-glue-mltransform-gluetables-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` // A unique identifier for the AWS Glue Data Catalog . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-gluetables.html#cfn-glue-mltransform-gluetables-catalogid // CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The name of the connection to the AWS Glue Data Catalog . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-gluetables.html#cfn-glue-mltransform-gluetables-connectionname // ConnectionName *string `field:"optional" json:"connectionName" yaml:"connectionName"` }
The database and table in the AWS Glue Data Catalog that is used for input or output data.
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" glueTablesProperty := &GlueTablesProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), ConnectionName: jsii.String("connectionName"), }
type CfnMLTransform_InputRecordTablesProperty ¶
type CfnMLTransform_InputRecordTablesProperty struct { // The database and table in the AWS Glue Data Catalog that is used for input or output data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-inputrecordtables.html#cfn-glue-mltransform-inputrecordtables-gluetables // GlueTables interface{} `field:"optional" json:"glueTables" yaml:"glueTables"` }
A list of AWS Glue table definitions used by the transform.
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" inputRecordTablesProperty := &InputRecordTablesProperty{ GlueTables: []interface{}{ &GlueTablesProperty{ DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), // the properties below are optional CatalogId: jsii.String("catalogId"), ConnectionName: jsii.String("connectionName"), }, }, }
type CfnMLTransform_MLUserDataEncryptionProperty ¶
type CfnMLTransform_MLUserDataEncryptionProperty struct { // The encryption mode applied to user data. Valid values are:. // // - DISABLED: encryption is disabled. // - SSEKMS: use of server-side encryption with AWS Key Management Service (SSE-KMS) for user data // stored in Amazon S3. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-mluserdataencryption.html#cfn-glue-mltransform-mluserdataencryption-mluserdataencryptionmode // MlUserDataEncryptionMode *string `field:"required" json:"mlUserDataEncryptionMode" yaml:"mlUserDataEncryptionMode"` // The ID for the customer-provided KMS key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-mluserdataencryption.html#cfn-glue-mltransform-mluserdataencryption-kmskeyid // KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` }
The encryption-at-rest settings of the transform that apply to accessing user data.
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" mLUserDataEncryptionProperty := &MLUserDataEncryptionProperty{ MlUserDataEncryptionMode: jsii.String("mlUserDataEncryptionMode"), // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }
type CfnMLTransform_TransformEncryptionProperty ¶
type CfnMLTransform_TransformEncryptionProperty struct { // The encryption-at-rest settings of the transform that apply to accessing user data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformencryption.html#cfn-glue-mltransform-transformencryption-mluserdataencryption // MlUserDataEncryption interface{} `field:"optional" json:"mlUserDataEncryption" yaml:"mlUserDataEncryption"` // The name of the security configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformencryption.html#cfn-glue-mltransform-transformencryption-taskrunsecurityconfigurationname // TaskRunSecurityConfigurationName *string `field:"optional" json:"taskRunSecurityConfigurationName" yaml:"taskRunSecurityConfigurationName"` }
The encryption-at-rest settings of the transform that apply to accessing user data.
Machine learning transforms can access user data encrypted in Amazon S3 using KMS.
Additionally, imported labels and trained transforms can now be encrypted using a customer provided KMS key.
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" transformEncryptionProperty := &TransformEncryptionProperty{ MlUserDataEncryption: &MLUserDataEncryptionProperty{ MlUserDataEncryptionMode: jsii.String("mlUserDataEncryptionMode"), // the properties below are optional KmsKeyId: jsii.String("kmsKeyId"), }, TaskRunSecurityConfigurationName: jsii.String("taskRunSecurityConfigurationName"), }
type CfnMLTransform_TransformParametersProperty ¶
type CfnMLTransform_TransformParametersProperty struct { // The type of machine learning transform. `FIND_MATCHES` is the only option. // // For information about the types of machine learning transforms, see [Working with machine learning transforms](https://docs.aws.amazon.com/glue/latest/dg/console-machine-learning-transforms.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters.html#cfn-glue-mltransform-transformparameters-transformtype // TransformType *string `field:"required" json:"transformType" yaml:"transformType"` // The parameters for the find matches algorithm. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-mltransform-transformparameters.html#cfn-glue-mltransform-transformparameters-findmatchesparameters // FindMatchesParameters interface{} `field:"optional" json:"findMatchesParameters" yaml:"findMatchesParameters"` }
The algorithm-specific parameters that are associated with the machine learning transform.
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" transformParametersProperty := &TransformParametersProperty{ TransformType: jsii.String("transformType"), // the properties below are optional FindMatchesParameters: &FindMatchesParametersProperty{ PrimaryKeyColumnName: jsii.String("primaryKeyColumnName"), // the properties below are optional AccuracyCostTradeoff: jsii.Number(123), EnforceProvidedLabels: jsii.Boolean(false), PrecisionRecallTradeoff: jsii.Number(123), }, }
type CfnPartition ¶
type CfnPartition interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // The AWS account ID of the catalog in which the partion is to be created. CatalogId() *string SetCatalogId(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 name of the catalog database in which to create the partition. DatabaseName() *string SetDatabaseName(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 tree node. Node() constructs.Node // The structure used to create and update a partition. PartitionInput() interface{} SetPartitionInput(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 // The name of the metadata table in which the partition is to be created. TableName() *string SetTableName(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::Glue::Partition` resource creates an AWS Glue partition, which represents a slice of table data.
For more information, see [CreatePartition Action](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-CreatePartition) and [Partition Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-partitions.html#aws-glue-api-catalog-partitions-Partition) in the *AWS Glue Developer Guide* .
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 parameters interface{} var skewedColumnValueLocationMaps interface{} cfnPartition := awscdk.Aws_glue.NewCfnPartition(this, jsii.String("MyCfnPartition"), &CfnPartitionProps{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), PartitionInput: &PartitionInputProperty{ Values: []*string{ jsii.String("values"), }, // the properties below are optional Parameters: parameters, StorageDescriptor: &StorageDescriptorProperty{ BucketColumns: []*string{ jsii.String("bucketColumns"), }, Columns: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Compressed: jsii.Boolean(false), InputFormat: jsii.String("inputFormat"), Location: jsii.String("location"), NumberOfBuckets: jsii.Number(123), OutputFormat: jsii.String("outputFormat"), Parameters: parameters, SchemaReference: &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }, SerdeInfo: &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }, SkewedInfo: &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }, SortColumns: []interface{}{ &OrderProperty{ Column: jsii.String("column"), // the properties below are optional SortOrder: jsii.Number(123), }, }, StoredAsSubDirectories: jsii.Boolean(false), }, }, TableName: jsii.String("tableName"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html
func NewCfnPartition ¶
func NewCfnPartition(scope constructs.Construct, id *string, props *CfnPartitionProps) CfnPartition
type CfnPartitionProps ¶
type CfnPartitionProps struct { // The AWS account ID of the catalog in which the partion is to be created. // // > To specify the account ID, you can use the `Ref` intrinsic function with the `AWS::AccountId` pseudo parameter. For example: `!Ref AWS::AccountId` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The name of the catalog database in which to create the partition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The structure used to create and update a partition. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-partitioninput // PartitionInput interface{} `field:"required" json:"partitionInput" yaml:"partitionInput"` // The name of the metadata table in which the partition is to be created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html#cfn-glue-partition-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` }
Properties for defining a `CfnPartition`.
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 parameters interface{} var skewedColumnValueLocationMaps interface{} cfnPartitionProps := &CfnPartitionProps{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), PartitionInput: &PartitionInputProperty{ Values: []*string{ jsii.String("values"), }, // the properties below are optional Parameters: parameters, StorageDescriptor: &StorageDescriptorProperty{ BucketColumns: []*string{ jsii.String("bucketColumns"), }, Columns: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Compressed: jsii.Boolean(false), InputFormat: jsii.String("inputFormat"), Location: jsii.String("location"), NumberOfBuckets: jsii.Number(123), OutputFormat: jsii.String("outputFormat"), Parameters: parameters, SchemaReference: &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }, SerdeInfo: &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }, SkewedInfo: &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }, SortColumns: []interface{}{ &OrderProperty{ Column: jsii.String("column"), // the properties below are optional SortOrder: jsii.Number(123), }, }, StoredAsSubDirectories: jsii.Boolean(false), }, }, TableName: jsii.String("tableName"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-partition.html
type CfnPartition_ColumnProperty ¶
type CfnPartition_ColumnProperty struct { // The name of the `Column` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-name // Name *string `field:"required" json:"name" yaml:"name"` // A free-form text comment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-comment // Comment *string `field:"optional" json:"comment" yaml:"comment"` // The data type of the `Column` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-column.html#cfn-glue-partition-column-type // Type *string `field:"optional" json:"type" yaml:"type"` }
A column in a `Table` .
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" columnProperty := &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }
type CfnPartition_OrderProperty ¶
type CfnPartition_OrderProperty struct { // The name of the column. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-column // Column *string `field:"required" json:"column" yaml:"column"` // Indicates that the column is sorted in ascending order ( `== 1` ), or in descending order ( `==0` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-order.html#cfn-glue-partition-order-sortorder // SortOrder *float64 `field:"optional" json:"sortOrder" yaml:"sortOrder"` }
Specifies the sort order of a sorted column.
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" orderProperty := &OrderProperty{ Column: jsii.String("column"), // the properties below are optional SortOrder: jsii.Number(123), }
type CfnPartition_PartitionInputProperty ¶
type CfnPartition_PartitionInputProperty struct { // The values of the partition. // // Although this parameter is not required by the SDK, you must specify this parameter for a valid input. // // The values for the keys for the new partition must be passed as an array of String objects that must be ordered in the same order as the partition keys appearing in the Amazon S3 prefix. Otherwise AWS Glue will add the values to the wrong keys. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-values // Values *[]*string `field:"required" json:"values" yaml:"values"` // These key-value pairs define partition parameters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // Provides information about the physical location where the partition is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-partitioninput.html#cfn-glue-partition-partitioninput-storagedescriptor // StorageDescriptor interface{} `field:"optional" json:"storageDescriptor" yaml:"storageDescriptor"` }
The structure used to create and update a partition.
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 parameters interface{} var skewedColumnValueLocationMaps interface{} partitionInputProperty := &PartitionInputProperty{ Values: []*string{ jsii.String("values"), }, // the properties below are optional Parameters: parameters, StorageDescriptor: &StorageDescriptorProperty{ BucketColumns: []*string{ jsii.String("bucketColumns"), }, Columns: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Compressed: jsii.Boolean(false), InputFormat: jsii.String("inputFormat"), Location: jsii.String("location"), NumberOfBuckets: jsii.Number(123), OutputFormat: jsii.String("outputFormat"), Parameters: parameters, SchemaReference: &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }, SerdeInfo: &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }, SkewedInfo: &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }, SortColumns: []interface{}{ &OrderProperty{ Column: jsii.String("column"), // the properties below are optional SortOrder: jsii.Number(123), }, }, StoredAsSubDirectories: jsii.Boolean(false), }, }
type CfnPartition_SchemaIdProperty ¶
type CfnPartition_SchemaIdProperty struct { // The name of the schema registry that contains the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html#cfn-glue-partition-schemaid-registryname // RegistryName *string `field:"optional" json:"registryName" yaml:"registryName"` // The Amazon Resource Name (ARN) of the schema. // // One of `SchemaArn` or `SchemaName` has to be // provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html#cfn-glue-partition-schemaid-schemaarn // SchemaArn *string `field:"optional" json:"schemaArn" yaml:"schemaArn"` // The name of the schema. // // One of `SchemaArn` or `SchemaName` has to be provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemaid.html#cfn-glue-partition-schemaid-schemaname // SchemaName *string `field:"optional" json:"schemaName" yaml:"schemaName"` }
A structure that contains schema identity fields.
Either this or the `SchemaVersionId` has to be provided.
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" schemaIdProperty := &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }
type CfnPartition_SchemaReferenceProperty ¶
type CfnPartition_SchemaReferenceProperty struct { // A structure that contains schema identity fields. // // Either this or the `SchemaVersionId` has to be // provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html#cfn-glue-partition-schemareference-schemaid // SchemaId interface{} `field:"optional" json:"schemaId" yaml:"schemaId"` // The unique ID assigned to a version of the schema. // // Either this or the `SchemaId` has to be provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html#cfn-glue-partition-schemareference-schemaversionid // SchemaVersionId *string `field:"optional" json:"schemaVersionId" yaml:"schemaVersionId"` // The version number of the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-schemareference.html#cfn-glue-partition-schemareference-schemaversionnumber // SchemaVersionNumber *float64 `field:"optional" json:"schemaVersionNumber" yaml:"schemaVersionNumber"` }
An object that references a schema stored in the AWS Glue Schema Registry.
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" schemaReferenceProperty := &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }
type CfnPartition_SerdeInfoProperty ¶
type CfnPartition_SerdeInfoProperty struct { // Name of the SerDe. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-name // Name *string `field:"optional" json:"name" yaml:"name"` // These key-value pairs define initialization parameters for the SerDe. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // Usually the class that implements the SerDe. // // An example is `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-serdeinfo.html#cfn-glue-partition-serdeinfo-serializationlibrary // SerializationLibrary *string `field:"optional" json:"serializationLibrary" yaml:"serializationLibrary"` }
Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
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 parameters interface{} serdeInfoProperty := &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }
type CfnPartition_SkewedInfoProperty ¶
type CfnPartition_SkewedInfoProperty struct { // A list of names of columns that contain skewed values. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnnames // SkewedColumnNames *[]*string `field:"optional" json:"skewedColumnNames" yaml:"skewedColumnNames"` // A mapping of skewed values to the columns that contain them. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvaluelocationmaps // SkewedColumnValueLocationMaps interface{} `field:"optional" json:"skewedColumnValueLocationMaps" yaml:"skewedColumnValueLocationMaps"` // A list of values that appear so frequently as to be considered skewed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-skewedinfo.html#cfn-glue-partition-skewedinfo-skewedcolumnvalues // SkewedColumnValues *[]*string `field:"optional" json:"skewedColumnValues" yaml:"skewedColumnValues"` }
Specifies skewed values in a table.
Skewed values are those that occur with very high frequency.
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 skewedColumnValueLocationMaps interface{} skewedInfoProperty := &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }
type CfnPartition_StorageDescriptorProperty ¶
type CfnPartition_StorageDescriptorProperty struct { // A list of reducer grouping columns, clustering columns, and bucketing columns in the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-bucketcolumns // BucketColumns *[]*string `field:"optional" json:"bucketColumns" yaml:"bucketColumns"` // A list of the `Columns` in the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-columns // Columns interface{} `field:"optional" json:"columns" yaml:"columns"` // `True` if the data in the table is compressed, or `False` if not. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-compressed // Compressed interface{} `field:"optional" json:"compressed" yaml:"compressed"` // The input format: `SequenceFileInputFormat` (binary), or `TextInputFormat` , or a custom format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-inputformat // InputFormat *string `field:"optional" json:"inputFormat" yaml:"inputFormat"` // The physical location of the table. // // By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-location // Location *string `field:"optional" json:"location" yaml:"location"` // The number of buckets. // // You must specify this property if the partition contains any dimension columns. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-numberofbuckets // NumberOfBuckets *float64 `field:"optional" json:"numberOfBuckets" yaml:"numberOfBuckets"` // The output format: `SequenceFileOutputFormat` (binary), or `IgnoreKeyTextOutputFormat` , or a custom format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-outputformat // OutputFormat *string `field:"optional" json:"outputFormat" yaml:"outputFormat"` // The user-supplied properties in key-value form. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // An object that references a schema stored in the AWS Glue Schema Registry. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-schemareference // SchemaReference interface{} `field:"optional" json:"schemaReference" yaml:"schemaReference"` // The serialization/deserialization (SerDe) information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-serdeinfo // SerdeInfo interface{} `field:"optional" json:"serdeInfo" yaml:"serdeInfo"` // The information about values that appear frequently in a column (skewed values). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-skewedinfo // SkewedInfo interface{} `field:"optional" json:"skewedInfo" yaml:"skewedInfo"` // A list specifying the sort order of each bucket in the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-sortcolumns // SortColumns interface{} `field:"optional" json:"sortColumns" yaml:"sortColumns"` // `True` if the table data is stored in subdirectories, or `False` if not. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-partition-storagedescriptor.html#cfn-glue-partition-storagedescriptor-storedassubdirectories // StoredAsSubDirectories interface{} `field:"optional" json:"storedAsSubDirectories" yaml:"storedAsSubDirectories"` }
Describes the physical storage of table data.
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 parameters interface{} var skewedColumnValueLocationMaps interface{} storageDescriptorProperty := &StorageDescriptorProperty{ BucketColumns: []*string{ jsii.String("bucketColumns"), }, Columns: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Compressed: jsii.Boolean(false), InputFormat: jsii.String("inputFormat"), Location: jsii.String("location"), NumberOfBuckets: jsii.Number(123), OutputFormat: jsii.String("outputFormat"), Parameters: parameters, SchemaReference: &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }, SerdeInfo: &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }, SkewedInfo: &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }, SortColumns: []interface{}{ &OrderProperty{ Column: jsii.String("column"), // the properties below are optional SortOrder: jsii.Number(123), }, }, StoredAsSubDirectories: jsii.Boolean(false), }
type CfnRegistry ¶
type CfnRegistry interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // Amazon Resource Name for the created Registry. AttrArn() *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 // A description of the registry. Description() *string SetDescription(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 registry. 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 stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // AWS tags that contain a key value pair and may be searched by console, command line, or API. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(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::Glue::Registry is an AWS Glue resource type that manages registries of schemas in the AWS Glue Schema Registry.
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" cfnRegistry := awscdk.Aws_glue.NewCfnRegistry(this, jsii.String("MyCfnRegistry"), &CfnRegistryProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html
func NewCfnRegistry ¶
func NewCfnRegistry(scope constructs.Construct, id *string, props *CfnRegistryProps) CfnRegistry
type CfnRegistryProps ¶
type CfnRegistryProps struct { // The name of the registry. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html#cfn-glue-registry-name // Name *string `field:"required" json:"name" yaml:"name"` // A description of the registry. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html#cfn-glue-registry-description // Description *string `field:"optional" json:"description" yaml:"description"` // AWS tags that contain a key value pair and may be searched by console, command line, or API. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html#cfn-glue-registry-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnRegistry`.
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" cfnRegistryProps := &CfnRegistryProps{ Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-registry.html
type CfnSchema ¶
type CfnSchema interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the schema. AttrArn() *string // Represents the version ID associated with the initial schema version. AttrInitialSchemaVersionId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Specify the `VersionNumber` or the `IsLatest` for setting the checkpoint for the schema. CheckpointVersion() interface{} SetCheckpointVersion(val interface{}) // The compatibility mode of the schema. Compatibility() *string SetCompatibility(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 // The data format of the schema definition. DataFormat() *string SetDataFormat(val *string) // A description of the schema if specified when created. Description() *string SetDescription(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 // Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. 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 registry where a schema is stored. Registry() interface{} SetRegistry(val interface{}) // The schema definition using the `DataFormat` setting for `SchemaName` . SchemaDefinition() *string SetSchemaDefinition(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // AWS tags that contain a key value pair and may be searched by console, command line, or API. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(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::Glue::Schema` is an AWS Glue resource type that manages schemas in the AWS Glue Schema Registry.
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" cfnSchema := awscdk.Aws_glue.NewCfnSchema(this, jsii.String("MyCfnSchema"), &CfnSchemaProps{ Compatibility: jsii.String("compatibility"), DataFormat: jsii.String("dataFormat"), Name: jsii.String("name"), // the properties below are optional CheckpointVersion: &SchemaVersionProperty{ IsLatest: jsii.Boolean(false), VersionNumber: jsii.Number(123), }, Description: jsii.String("description"), Registry: &RegistryProperty{ Arn: jsii.String("arn"), Name: jsii.String("name"), }, SchemaDefinition: jsii.String("schemaDefinition"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html
func NewCfnSchema ¶
func NewCfnSchema(scope constructs.Construct, id *string, props *CfnSchemaProps) CfnSchema
type CfnSchemaProps ¶
type CfnSchemaProps struct { // The compatibility mode of the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-compatibility // Compatibility *string `field:"required" json:"compatibility" yaml:"compatibility"` // The data format of the schema definition. // // Currently only `AVRO` is supported. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-dataformat // DataFormat *string `field:"required" json:"dataFormat" yaml:"dataFormat"` // Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. // // No whitespace. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-name // Name *string `field:"required" json:"name" yaml:"name"` // Specify the `VersionNumber` or the `IsLatest` for setting the checkpoint for the schema. // // This is only required for updating a checkpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-checkpointversion // CheckpointVersion interface{} `field:"optional" json:"checkpointVersion" yaml:"checkpointVersion"` // A description of the schema if specified when created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-description // Description *string `field:"optional" json:"description" yaml:"description"` // The registry where a schema is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-registry // Registry interface{} `field:"optional" json:"registry" yaml:"registry"` // The schema definition using the `DataFormat` setting for `SchemaName` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-schemadefinition // SchemaDefinition *string `field:"optional" json:"schemaDefinition" yaml:"schemaDefinition"` // AWS tags that contain a key value pair and may be searched by console, command line, or API. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSchema`.
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" cfnSchemaProps := &CfnSchemaProps{ Compatibility: jsii.String("compatibility"), DataFormat: jsii.String("dataFormat"), Name: jsii.String("name"), // the properties below are optional CheckpointVersion: &SchemaVersionProperty{ IsLatest: jsii.Boolean(false), VersionNumber: jsii.Number(123), }, Description: jsii.String("description"), Registry: &RegistryProperty{ Arn: jsii.String("arn"), Name: jsii.String("name"), }, SchemaDefinition: jsii.String("schemaDefinition"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html
type CfnSchemaVersion ¶
type CfnSchemaVersion interface { awscdk.CfnResource awscdk.IInspectable // Represents the version ID associated with the schema version. AttrVersionId() *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 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 schema that includes the schema version. Schema() interface{} SetSchema(val interface{}) // The schema definition for the schema version. SchemaDefinition() *string SetSchemaDefinition(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{}) }
The `AWS::Glue::SchemaVersion` is an AWS Glue resource type that manages schema versions of schemas in the AWS Glue Schema Registry.
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" cfnSchemaVersion := awscdk.Aws_glue.NewCfnSchemaVersion(this, jsii.String("MyCfnSchemaVersion"), &CfnSchemaVersionProps{ Schema: &SchemaProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaDefinition: jsii.String("schemaDefinition"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversion.html
func NewCfnSchemaVersion ¶
func NewCfnSchemaVersion(scope constructs.Construct, id *string, props *CfnSchemaVersionProps) CfnSchemaVersion
type CfnSchemaVersionMetadata ¶
type CfnSchemaVersionMetadata interface { awscdk.CfnResource awscdk.IInspectable // 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 // A metadata key in a key-value pair for metadata. Key() *string SetKey(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 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 version number of the schema. SchemaVersionId() *string SetSchemaVersionId(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{} // A metadata key's corresponding value. Value() *string SetValue(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 `AWS::Glue::SchemaVersionMetadata` is an AWS Glue resource type that defines the metadata key-value pairs for a schema version in AWS Glue Schema Registry.
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" cfnSchemaVersionMetadata := awscdk.Aws_glue.NewCfnSchemaVersionMetadata(this, jsii.String("MyCfnSchemaVersionMetadata"), &CfnSchemaVersionMetadataProps{ Key: jsii.String("key"), SchemaVersionId: jsii.String("schemaVersionId"), Value: jsii.String("value"), })
func NewCfnSchemaVersionMetadata ¶
func NewCfnSchemaVersionMetadata(scope constructs.Construct, id *string, props *CfnSchemaVersionMetadataProps) CfnSchemaVersionMetadata
type CfnSchemaVersionMetadataProps ¶
type CfnSchemaVersionMetadataProps struct { // A metadata key in a key-value pair for metadata. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversionmetadata.html#cfn-glue-schemaversionmetadata-key // Key *string `field:"required" json:"key" yaml:"key"` // The version number of the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversionmetadata.html#cfn-glue-schemaversionmetadata-schemaversionid // SchemaVersionId *string `field:"required" json:"schemaVersionId" yaml:"schemaVersionId"` // A metadata key's corresponding value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversionmetadata.html#cfn-glue-schemaversionmetadata-value // Value *string `field:"required" json:"value" yaml:"value"` }
Properties for defining a `CfnSchemaVersionMetadata`.
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" cfnSchemaVersionMetadataProps := &CfnSchemaVersionMetadataProps{ Key: jsii.String("key"), SchemaVersionId: jsii.String("schemaVersionId"), Value: jsii.String("value"), }
type CfnSchemaVersionProps ¶
type CfnSchemaVersionProps struct { // The schema that includes the schema version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversion.html#cfn-glue-schemaversion-schema // Schema interface{} `field:"required" json:"schema" yaml:"schema"` // The schema definition for the schema version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversion.html#cfn-glue-schemaversion-schemadefinition // SchemaDefinition *string `field:"required" json:"schemaDefinition" yaml:"schemaDefinition"` }
Properties for defining a `CfnSchemaVersion`.
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" cfnSchemaVersionProps := &CfnSchemaVersionProps{ Schema: &SchemaProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaDefinition: jsii.String("schemaDefinition"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schemaversion.html
type CfnSchemaVersion_SchemaProperty ¶
type CfnSchemaVersion_SchemaProperty struct { // The name of the registry where the schema is stored. // // Either `SchemaArn` , or `SchemaName` and `RegistryName` has to be provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schemaversion-schema.html#cfn-glue-schemaversion-schema-registryname // RegistryName *string `field:"optional" json:"registryName" yaml:"registryName"` // The Amazon Resource Name (ARN) of the schema. // // Either `SchemaArn` , or `SchemaName` and `RegistryName` has to be provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schemaversion-schema.html#cfn-glue-schemaversion-schema-schemaarn // SchemaArn *string `field:"optional" json:"schemaArn" yaml:"schemaArn"` // The name of the schema. // // Either `SchemaArn` , or `SchemaName` and `RegistryName` has to be provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schemaversion-schema.html#cfn-glue-schemaversion-schema-schemaname // SchemaName *string `field:"optional" json:"schemaName" yaml:"schemaName"` }
A wrapper structure to contain schema identity fields.
Either `SchemaArn` , or `SchemaName` and `RegistryName` has to be provided.
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" schemaProperty := &SchemaProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }
type CfnSchema_RegistryProperty ¶
type CfnSchema_RegistryProperty struct { // The Amazon Resource Name (ARN) of the registry. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-registry.html#cfn-glue-schema-registry-arn // Arn *string `field:"optional" json:"arn" yaml:"arn"` // The name of the registry. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-registry.html#cfn-glue-schema-registry-name // Name *string `field:"optional" json:"name" yaml:"name"` }
Specifies a registry in the AWS Glue Schema Registry.
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" registryProperty := &RegistryProperty{ Arn: jsii.String("arn"), Name: jsii.String("name"), }
type CfnSchema_SchemaVersionProperty ¶
type CfnSchema_SchemaVersionProperty struct { // Indicates if this version is the latest version of the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-schemaversion.html#cfn-glue-schema-schemaversion-islatest // IsLatest interface{} `field:"optional" json:"isLatest" yaml:"isLatest"` // The version number of the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-schema-schemaversion.html#cfn-glue-schema-schemaversion-versionnumber // VersionNumber *float64 `field:"optional" json:"versionNumber" yaml:"versionNumber"` }
Specifies the version of a schema.
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" schemaVersionProperty := &SchemaVersionProperty{ IsLatest: jsii.Boolean(false), VersionNumber: jsii.Number(123), }
type CfnSecurityConfiguration ¶
type CfnSecurityConfiguration interface { awscdk.CfnResource awscdk.IInspectable 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 encryption configuration associated with this security configuration. EncryptionConfiguration() interface{} SetEncryptionConfiguration(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 the security configuration. 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 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{}) }
Creates a new security configuration.
A security configuration is a set of security properties that can be used by AWS Glue . You can use a security configuration to encrypt data at rest. For information about using security configurations in AWS Glue , see [Encrypting Data Written by Crawlers, Jobs, and Development Endpoints](https://docs.aws.amazon.com/glue/latest/dg/encryption-security-configuration.html) .
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" cfnSecurityConfiguration := awscdk.Aws_glue.NewCfnSecurityConfiguration(this, jsii.String("MyCfnSecurityConfiguration"), &CfnSecurityConfigurationProps{ EncryptionConfiguration: &EncryptionConfigurationProperty{ CloudWatchEncryption: &CloudWatchEncryptionProperty{ CloudWatchEncryptionMode: jsii.String("cloudWatchEncryptionMode"), KmsKeyArn: jsii.String("kmsKeyArn"), }, JobBookmarksEncryption: &JobBookmarksEncryptionProperty{ JobBookmarksEncryptionMode: jsii.String("jobBookmarksEncryptionMode"), KmsKeyArn: jsii.String("kmsKeyArn"), }, S3Encryptions: []interface{}{ &S3EncryptionProperty{ KmsKeyArn: jsii.String("kmsKeyArn"), S3EncryptionMode: jsii.String("s3EncryptionMode"), }, }, }, Name: jsii.String("name"), })
func NewCfnSecurityConfiguration ¶
func NewCfnSecurityConfiguration(scope constructs.Construct, id *string, props *CfnSecurityConfigurationProps) CfnSecurityConfiguration
type CfnSecurityConfigurationProps ¶
type CfnSecurityConfigurationProps struct { // The encryption configuration associated with this security configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration // EncryptionConfiguration interface{} `field:"required" json:"encryptionConfiguration" yaml:"encryptionConfiguration"` // The name of the security configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-securityconfiguration.html#cfn-glue-securityconfiguration-name // Name *string `field:"required" json:"name" yaml:"name"` }
Properties for defining a `CfnSecurityConfiguration`.
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" cfnSecurityConfigurationProps := &CfnSecurityConfigurationProps{ EncryptionConfiguration: &EncryptionConfigurationProperty{ CloudWatchEncryption: &CloudWatchEncryptionProperty{ CloudWatchEncryptionMode: jsii.String("cloudWatchEncryptionMode"), KmsKeyArn: jsii.String("kmsKeyArn"), }, JobBookmarksEncryption: &JobBookmarksEncryptionProperty{ JobBookmarksEncryptionMode: jsii.String("jobBookmarksEncryptionMode"), KmsKeyArn: jsii.String("kmsKeyArn"), }, S3Encryptions: []interface{}{ &S3EncryptionProperty{ KmsKeyArn: jsii.String("kmsKeyArn"), S3EncryptionMode: jsii.String("s3EncryptionMode"), }, }, }, Name: jsii.String("name"), }
type CfnSecurityConfiguration_CloudWatchEncryptionProperty ¶
type CfnSecurityConfiguration_CloudWatchEncryptionProperty struct { // The encryption mode to use for CloudWatch data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html#cfn-glue-securityconfiguration-cloudwatchencryption-cloudwatchencryptionmode // CloudWatchEncryptionMode *string `field:"optional" json:"cloudWatchEncryptionMode" yaml:"cloudWatchEncryptionMode"` // The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-cloudwatchencryption.html#cfn-glue-securityconfiguration-cloudwatchencryption-kmskeyarn // KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"` }
Specifies how Amazon CloudWatch data should be encrypted.
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" cloudWatchEncryptionProperty := &CloudWatchEncryptionProperty{ CloudWatchEncryptionMode: jsii.String("cloudWatchEncryptionMode"), KmsKeyArn: jsii.String("kmsKeyArn"), }
type CfnSecurityConfiguration_EncryptionConfigurationProperty ¶
type CfnSecurityConfiguration_EncryptionConfigurationProperty struct { // The encryption configuration for Amazon CloudWatch. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-cloudwatchencryption // CloudWatchEncryption interface{} `field:"optional" json:"cloudWatchEncryption" yaml:"cloudWatchEncryption"` // The encryption configuration for job bookmarks. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-jobbookmarksencryption // JobBookmarksEncryption interface{} `field:"optional" json:"jobBookmarksEncryption" yaml:"jobBookmarksEncryption"` // The encyption configuration for Amazon Simple Storage Service (Amazon S3) data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-encryptionconfiguration.html#cfn-glue-securityconfiguration-encryptionconfiguration-s3encryptions // S3Encryptions interface{} `field:"optional" json:"s3Encryptions" yaml:"s3Encryptions"` }
Specifies an encryption 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" encryptionConfigurationProperty := &EncryptionConfigurationProperty{ CloudWatchEncryption: &CloudWatchEncryptionProperty{ CloudWatchEncryptionMode: jsii.String("cloudWatchEncryptionMode"), KmsKeyArn: jsii.String("kmsKeyArn"), }, JobBookmarksEncryption: &JobBookmarksEncryptionProperty{ JobBookmarksEncryptionMode: jsii.String("jobBookmarksEncryptionMode"), KmsKeyArn: jsii.String("kmsKeyArn"), }, S3Encryptions: []interface{}{ &S3EncryptionProperty{ KmsKeyArn: jsii.String("kmsKeyArn"), S3EncryptionMode: jsii.String("s3EncryptionMode"), }, }, }
type CfnSecurityConfiguration_JobBookmarksEncryptionProperty ¶
type CfnSecurityConfiguration_JobBookmarksEncryptionProperty struct { // The encryption mode to use for job bookmarks data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html#cfn-glue-securityconfiguration-jobbookmarksencryption-jobbookmarksencryptionmode // JobBookmarksEncryptionMode *string `field:"optional" json:"jobBookmarksEncryptionMode" yaml:"jobBookmarksEncryptionMode"` // The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-jobbookmarksencryption.html#cfn-glue-securityconfiguration-jobbookmarksencryption-kmskeyarn // KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"` }
Specifies how job bookmark data should be encrypted.
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" jobBookmarksEncryptionProperty := &JobBookmarksEncryptionProperty{ JobBookmarksEncryptionMode: jsii.String("jobBookmarksEncryptionMode"), KmsKeyArn: jsii.String("kmsKeyArn"), }
type CfnSecurityConfiguration_S3EncryptionProperty ¶
type CfnSecurityConfiguration_S3EncryptionProperty struct { // The Amazon Resource Name (ARN) of the KMS key to be used to encrypt the data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html#cfn-glue-securityconfiguration-s3encryption-kmskeyarn // KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"` // The encryption mode to use for Amazon S3 data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-securityconfiguration-s3encryption.html#cfn-glue-securityconfiguration-s3encryption-s3encryptionmode // S3EncryptionMode *string `field:"optional" json:"s3EncryptionMode" yaml:"s3EncryptionMode"` }
Specifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.
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" s3EncryptionProperty := &S3EncryptionProperty{ KmsKeyArn: jsii.String("kmsKeyArn"), S3EncryptionMode: jsii.String("s3EncryptionMode"), }
type CfnTable ¶
type CfnTable interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // The ID of the Data Catalog in which to create the `Table` . CatalogId() *string SetCatalogId(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 name of the database where the table metadata resides. DatabaseName() *string SetDatabaseName(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 tree node. Node() constructs.Node // Specifies an `OpenTableFormatInput` structure when creating an open format table. OpenTableFormatInput() interface{} SetOpenTableFormatInput(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 // A structure used to define a table. TableInput() interface{} SetTableInput(val interface{}) // 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::Glue::Table` resource specifies tabular data in the AWS Glue data catalog.
For more information, see [Defining Tables in the AWS Glue Data Catalog](https://docs.aws.amazon.com/glue/latest/dg/tables-described.html) and [Table Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-catalog-tables.html#aws-glue-api-catalog-tables-Table) in the *AWS Glue Developer Guide* .
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 parameters interface{} var skewedColumnValueLocationMaps interface{} cfnTable := awscdk.Aws_glue.NewCfnTable(this, jsii.String("MyCfnTable"), &CfnTableProps{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), TableInput: &TableInputProperty{ Description: jsii.String("description"), Name: jsii.String("name"), Owner: jsii.String("owner"), Parameters: parameters, PartitionKeys: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Retention: jsii.Number(123), StorageDescriptor: &StorageDescriptorProperty{ BucketColumns: []*string{ jsii.String("bucketColumns"), }, Columns: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Compressed: jsii.Boolean(false), InputFormat: jsii.String("inputFormat"), Location: jsii.String("location"), NumberOfBuckets: jsii.Number(123), OutputFormat: jsii.String("outputFormat"), Parameters: parameters, SchemaReference: &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }, SerdeInfo: &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }, SkewedInfo: &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }, SortColumns: []interface{}{ &OrderProperty{ Column: jsii.String("column"), SortOrder: jsii.Number(123), }, }, StoredAsSubDirectories: jsii.Boolean(false), }, TableType: jsii.String("tableType"), TargetTable: &TableIdentifierProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), Region: jsii.String("region"), }, ViewExpandedText: jsii.String("viewExpandedText"), ViewOriginalText: jsii.String("viewOriginalText"), }, // the properties below are optional OpenTableFormatInput: &OpenTableFormatInputProperty{ IcebergInput: &IcebergInputProperty{ MetadataOperation: jsii.String("metadataOperation"), Version: jsii.String("version"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html
func NewCfnTable ¶
func NewCfnTable(scope constructs.Construct, id *string, props *CfnTableProps) CfnTable
type CfnTableOptimizer ¶ added in v2.127.0
type CfnTableOptimizer interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // The catalog ID of the table. CatalogId() *string SetCatalogId(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 name of the database. DatabaseName() *string SetDatabaseName(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 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 table name. TableName() *string SetTableName(val *string) // Specifies configuration details of a table optimizer. TableOptimizerConfiguration() interface{} SetTableOptimizerConfiguration(val interface{}) // The type of table optimizer. 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{}) }
A resource that describes the AWS Glue resource for enabling compaction to improve read performance for open table formats.
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" cfnTableOptimizer := awscdk.Aws_glue.NewCfnTableOptimizer(this, jsii.String("MyCfnTableOptimizer"), &CfnTableOptimizerProps{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), TableOptimizerConfiguration: &TableOptimizerConfigurationProperty{ Enabled: jsii.Boolean(false), RoleArn: jsii.String("roleArn"), }, Type: jsii.String("type"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html
func NewCfnTableOptimizer ¶ added in v2.127.0
func NewCfnTableOptimizer(scope constructs.Construct, id *string, props *CfnTableOptimizerProps) CfnTableOptimizer
type CfnTableOptimizerProps ¶ added in v2.127.0
type CfnTableOptimizerProps struct { // The catalog ID of the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The name of the database. // // For Hive compatibility, this is folded to lowercase when it is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The table name. // // For Hive compatibility, this must be entirely lowercase. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-tablename // TableName *string `field:"required" json:"tableName" yaml:"tableName"` // Specifies configuration details of a table optimizer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration // TableOptimizerConfiguration interface{} `field:"required" json:"tableOptimizerConfiguration" yaml:"tableOptimizerConfiguration"` // The type of table optimizer. // // Currently, the only valid value is compaction. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html#cfn-glue-tableoptimizer-type // Type *string `field:"required" json:"type" yaml:"type"` }
Properties for defining a `CfnTableOptimizer`.
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" cfnTableOptimizerProps := &CfnTableOptimizerProps{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), TableName: jsii.String("tableName"), TableOptimizerConfiguration: &TableOptimizerConfigurationProperty{ Enabled: jsii.Boolean(false), RoleArn: jsii.String("roleArn"), }, Type: jsii.String("type"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-tableoptimizer.html
type CfnTableOptimizer_TableOptimizerConfigurationProperty ¶ added in v2.127.0
type CfnTableOptimizer_TableOptimizerConfigurationProperty struct { // Whether the table optimization is enabled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-enabled // Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"` // A role passed by the caller which gives the service permission to update the resources associated with the optimizer on the caller's behalf. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-tableoptimizer-tableoptimizerconfiguration.html#cfn-glue-tableoptimizer-tableoptimizerconfiguration-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` }
Specifies configuration details of a table optimizer.
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" tableOptimizerConfigurationProperty := &TableOptimizerConfigurationProperty{ Enabled: jsii.Boolean(false), RoleArn: jsii.String("roleArn"), }
type CfnTableProps ¶
type CfnTableProps struct { // The ID of the Data Catalog in which to create the `Table` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-catalogid // CatalogId *string `field:"required" json:"catalogId" yaml:"catalogId"` // The name of the database where the table metadata resides. // // For Hive compatibility, this must be all lowercase. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // A structure used to define a table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-tableinput // TableInput interface{} `field:"required" json:"tableInput" yaml:"tableInput"` // Specifies an `OpenTableFormatInput` structure when creating an open format table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html#cfn-glue-table-opentableformatinput // OpenTableFormatInput interface{} `field:"optional" json:"openTableFormatInput" yaml:"openTableFormatInput"` }
Properties for defining a `CfnTable`.
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 parameters interface{} var skewedColumnValueLocationMaps interface{} cfnTableProps := &CfnTableProps{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), TableInput: &TableInputProperty{ Description: jsii.String("description"), Name: jsii.String("name"), Owner: jsii.String("owner"), Parameters: parameters, PartitionKeys: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Retention: jsii.Number(123), StorageDescriptor: &StorageDescriptorProperty{ BucketColumns: []*string{ jsii.String("bucketColumns"), }, Columns: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Compressed: jsii.Boolean(false), InputFormat: jsii.String("inputFormat"), Location: jsii.String("location"), NumberOfBuckets: jsii.Number(123), OutputFormat: jsii.String("outputFormat"), Parameters: parameters, SchemaReference: &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }, SerdeInfo: &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }, SkewedInfo: &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }, SortColumns: []interface{}{ &OrderProperty{ Column: jsii.String("column"), SortOrder: jsii.Number(123), }, }, StoredAsSubDirectories: jsii.Boolean(false), }, TableType: jsii.String("tableType"), TargetTable: &TableIdentifierProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), Region: jsii.String("region"), }, ViewExpandedText: jsii.String("viewExpandedText"), ViewOriginalText: jsii.String("viewOriginalText"), }, // the properties below are optional OpenTableFormatInput: &OpenTableFormatInputProperty{ IcebergInput: &IcebergInputProperty{ MetadataOperation: jsii.String("metadataOperation"), Version: jsii.String("version"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-table.html
type CfnTable_ColumnProperty ¶
type CfnTable_ColumnProperty struct { // The name of the `Column` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-name // Name *string `field:"required" json:"name" yaml:"name"` // A free-form text comment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-comment // Comment *string `field:"optional" json:"comment" yaml:"comment"` // The data type of the `Column` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html#cfn-glue-table-column-type // Type *string `field:"optional" json:"type" yaml:"type"` }
A column in a `Table` .
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" columnProperty := &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-column.html
type CfnTable_IcebergInputProperty ¶ added in v2.91.0
type CfnTable_IcebergInputProperty struct { // A required metadata operation. // // Can only be set to CREATE. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-iceberginput.html#cfn-glue-table-iceberginput-metadataoperation // MetadataOperation *string `field:"optional" json:"metadataOperation" yaml:"metadataOperation"` // The table version for the Iceberg table. // // Defaults to 2. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-iceberginput.html#cfn-glue-table-iceberginput-version // Version *string `field:"optional" json:"version" yaml:"version"` }
Specifies an input structure that defines an Apache Iceberg metadata table.
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" icebergInputProperty := &IcebergInputProperty{ MetadataOperation: jsii.String("metadataOperation"), Version: jsii.String("version"), }
type CfnTable_OpenTableFormatInputProperty ¶ added in v2.91.0
type CfnTable_OpenTableFormatInputProperty struct { // Specifies an `IcebergInput` structure that defines an Apache Iceberg metadata table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-opentableformatinput.html#cfn-glue-table-opentableformatinput-iceberginput // IcebergInput interface{} `field:"optional" json:"icebergInput" yaml:"icebergInput"` }
Specifies an `OpenTableFormatInput` structure when creating an open format table.
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" openTableFormatInputProperty := &OpenTableFormatInputProperty{ IcebergInput: &IcebergInputProperty{ MetadataOperation: jsii.String("metadataOperation"), Version: jsii.String("version"), }, }
type CfnTable_OrderProperty ¶
type CfnTable_OrderProperty struct { // The name of the column. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-column // Column *string `field:"required" json:"column" yaml:"column"` // Indicates that the column is sorted in ascending order ( `== 1` ), or in descending order ( `==0` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html#cfn-glue-table-order-sortorder // SortOrder *float64 `field:"required" json:"sortOrder" yaml:"sortOrder"` }
Specifies the sort order of a sorted column.
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" orderProperty := &OrderProperty{ Column: jsii.String("column"), SortOrder: jsii.Number(123), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-order.html
type CfnTable_SchemaIdProperty ¶
type CfnTable_SchemaIdProperty struct { // The name of the schema registry that contains the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemaid.html#cfn-glue-table-schemaid-registryname // RegistryName *string `field:"optional" json:"registryName" yaml:"registryName"` // The Amazon Resource Name (ARN) of the schema. // // One of `SchemaArn` or `SchemaName` has to be // provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemaid.html#cfn-glue-table-schemaid-schemaarn // SchemaArn *string `field:"optional" json:"schemaArn" yaml:"schemaArn"` // The name of the schema. // // One of `SchemaArn` or `SchemaName` has to be provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemaid.html#cfn-glue-table-schemaid-schemaname // SchemaName *string `field:"optional" json:"schemaName" yaml:"schemaName"` }
A structure that contains schema identity fields.
Either this or the `SchemaVersionId` has to be provided.
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" schemaIdProperty := &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }
type CfnTable_SchemaReferenceProperty ¶
type CfnTable_SchemaReferenceProperty struct { // A structure that contains schema identity fields. // // Either this or the `SchemaVersionId` has to be // provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemareference.html#cfn-glue-table-schemareference-schemaid // SchemaId interface{} `field:"optional" json:"schemaId" yaml:"schemaId"` // The unique ID assigned to a version of the schema. // // Either this or the `SchemaId` has to be provided. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemareference.html#cfn-glue-table-schemareference-schemaversionid // SchemaVersionId *string `field:"optional" json:"schemaVersionId" yaml:"schemaVersionId"` // The version number of the schema. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-schemareference.html#cfn-glue-table-schemareference-schemaversionnumber // SchemaVersionNumber *float64 `field:"optional" json:"schemaVersionNumber" yaml:"schemaVersionNumber"` }
An object that references a schema stored in the AWS Glue Schema Registry.
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" schemaReferenceProperty := &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }
type CfnTable_SerdeInfoProperty ¶
type CfnTable_SerdeInfoProperty struct { // Name of the SerDe. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-name // Name *string `field:"optional" json:"name" yaml:"name"` // These key-value pairs define initialization parameters for the SerDe. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // Usually the class that implements the SerDe. // // An example is `org.apache.hadoop.hive.serde2.columnar.ColumnarSerDe` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-serdeinfo.html#cfn-glue-table-serdeinfo-serializationlibrary // SerializationLibrary *string `field:"optional" json:"serializationLibrary" yaml:"serializationLibrary"` }
Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
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 parameters interface{} serdeInfoProperty := &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }
type CfnTable_SkewedInfoProperty ¶
type CfnTable_SkewedInfoProperty struct { // A list of names of columns that contain skewed values. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnnames // SkewedColumnNames *[]*string `field:"optional" json:"skewedColumnNames" yaml:"skewedColumnNames"` // A mapping of skewed values to the columns that contain them. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvaluelocationmaps // SkewedColumnValueLocationMaps interface{} `field:"optional" json:"skewedColumnValueLocationMaps" yaml:"skewedColumnValueLocationMaps"` // A list of values that appear so frequently as to be considered skewed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-skewedinfo.html#cfn-glue-table-skewedinfo-skewedcolumnvalues // SkewedColumnValues *[]*string `field:"optional" json:"skewedColumnValues" yaml:"skewedColumnValues"` }
Specifies skewed values in a table.
Skewed values are those that occur with very high frequency.
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 skewedColumnValueLocationMaps interface{} skewedInfoProperty := &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }
type CfnTable_StorageDescriptorProperty ¶
type CfnTable_StorageDescriptorProperty struct { // A list of reducer grouping columns, clustering columns, and bucketing columns in the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-bucketcolumns // BucketColumns *[]*string `field:"optional" json:"bucketColumns" yaml:"bucketColumns"` // A list of the `Columns` in the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-columns // Columns interface{} `field:"optional" json:"columns" yaml:"columns"` // `True` if the data in the table is compressed, or `False` if not. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-compressed // Compressed interface{} `field:"optional" json:"compressed" yaml:"compressed"` // The input format: `SequenceFileInputFormat` (binary), or `TextInputFormat` , or a custom format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-inputformat // InputFormat *string `field:"optional" json:"inputFormat" yaml:"inputFormat"` // The physical location of the table. // // By default, this takes the form of the warehouse location, followed by the database location in the warehouse, followed by the table name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-location // Location *string `field:"optional" json:"location" yaml:"location"` // Must be specified if the table contains any dimension columns. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-numberofbuckets // NumberOfBuckets *float64 `field:"optional" json:"numberOfBuckets" yaml:"numberOfBuckets"` // The output format: `SequenceFileOutputFormat` (binary), or `IgnoreKeyTextOutputFormat` , or a custom format. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-outputformat // OutputFormat *string `field:"optional" json:"outputFormat" yaml:"outputFormat"` // The user-supplied properties in key-value form. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // An object that references a schema stored in the AWS Glue Schema Registry. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-schemareference // SchemaReference interface{} `field:"optional" json:"schemaReference" yaml:"schemaReference"` // The serialization/deserialization (SerDe) information. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-serdeinfo // SerdeInfo interface{} `field:"optional" json:"serdeInfo" yaml:"serdeInfo"` // The information about values that appear frequently in a column (skewed values). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-skewedinfo // SkewedInfo interface{} `field:"optional" json:"skewedInfo" yaml:"skewedInfo"` // A list specifying the sort order of each bucket in the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-sortcolumns // SortColumns interface{} `field:"optional" json:"sortColumns" yaml:"sortColumns"` // `True` if the table data is stored in subdirectories, or `False` if not. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-storagedescriptor.html#cfn-glue-table-storagedescriptor-storedassubdirectories // StoredAsSubDirectories interface{} `field:"optional" json:"storedAsSubDirectories" yaml:"storedAsSubDirectories"` }
Describes the physical storage of table data.
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 parameters interface{} var skewedColumnValueLocationMaps interface{} storageDescriptorProperty := &StorageDescriptorProperty{ BucketColumns: []*string{ jsii.String("bucketColumns"), }, Columns: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Compressed: jsii.Boolean(false), InputFormat: jsii.String("inputFormat"), Location: jsii.String("location"), NumberOfBuckets: jsii.Number(123), OutputFormat: jsii.String("outputFormat"), Parameters: parameters, SchemaReference: &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }, SerdeInfo: &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }, SkewedInfo: &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }, SortColumns: []interface{}{ &OrderProperty{ Column: jsii.String("column"), SortOrder: jsii.Number(123), }, }, StoredAsSubDirectories: jsii.Boolean(false), }
type CfnTable_TableIdentifierProperty ¶
type CfnTable_TableIdentifierProperty struct { // The ID of the Data Catalog in which the table resides. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html#cfn-glue-table-tableidentifier-catalogid // CatalogId *string `field:"optional" json:"catalogId" yaml:"catalogId"` // The name of the catalog database that contains the target table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html#cfn-glue-table-tableidentifier-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // The name of the target table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html#cfn-glue-table-tableidentifier-name // Name *string `field:"optional" json:"name" yaml:"name"` // The Region of the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableidentifier.html#cfn-glue-table-tableidentifier-region // Region *string `field:"optional" json:"region" yaml:"region"` }
A structure that describes a target table for resource linking.
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" tableIdentifierProperty := &TableIdentifierProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), Region: jsii.String("region"), }
type CfnTable_TableInputProperty ¶
type CfnTable_TableInputProperty struct { // A description of the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-description // Description *string `field:"optional" json:"description" yaml:"description"` // The table name. // // For Hive compatibility, this is folded to lowercase when it is stored. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-name // Name *string `field:"optional" json:"name" yaml:"name"` // The table owner. // // Included for Apache Hive compatibility. Not used in the normal course of AWS Glue operations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-owner // Owner *string `field:"optional" json:"owner" yaml:"owner"` // These key-value pairs define properties associated with the table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // A list of columns by which the table is partitioned. Only primitive types are supported as partition keys. // // When you create a table used by Amazon Athena, and you do not specify any `partitionKeys` , you must at least set the value of `partitionKeys` to an empty list. For example: // // `"PartitionKeys": []`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-partitionkeys // PartitionKeys interface{} `field:"optional" json:"partitionKeys" yaml:"partitionKeys"` // The retention time for this table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-retention // Retention *float64 `field:"optional" json:"retention" yaml:"retention"` // A storage descriptor containing information about the physical storage of this table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-storagedescriptor // StorageDescriptor interface{} `field:"optional" json:"storageDescriptor" yaml:"storageDescriptor"` // The type of this table. // // AWS Glue will create tables with the `EXTERNAL_TABLE` type. Other services, such as Athena, may create tables with additional table types. // // AWS Glue related table types: // // - **EXTERNAL_TABLE** - Hive compatible attribute - indicates a non-Hive managed table. // - **GOVERNED** - Used by AWS Lake Formation . The AWS Glue Data Catalog understands `GOVERNED` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-tabletype // TableType *string `field:"optional" json:"tableType" yaml:"tableType"` // A `TableIdentifier` structure that describes a target table for resource linking. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-targettable // TargetTable interface{} `field:"optional" json:"targetTable" yaml:"targetTable"` // Included for Apache Hive compatibility. // // Not used in the normal course of AWS Glue operations. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-viewexpandedtext // ViewExpandedText *string `field:"optional" json:"viewExpandedText" yaml:"viewExpandedText"` // Included for Apache Hive compatibility. // // Not used in the normal course of AWS Glue operations. If the table is a `VIRTUAL_VIEW` , certain Athena configuration encoded in base64. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-table-tableinput.html#cfn-glue-table-tableinput-vieworiginaltext // ViewOriginalText *string `field:"optional" json:"viewOriginalText" yaml:"viewOriginalText"` }
A structure used to define a table.
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 parameters interface{} var skewedColumnValueLocationMaps interface{} tableInputProperty := &TableInputProperty{ Description: jsii.String("description"), Name: jsii.String("name"), Owner: jsii.String("owner"), Parameters: parameters, PartitionKeys: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Retention: jsii.Number(123), StorageDescriptor: &StorageDescriptorProperty{ BucketColumns: []*string{ jsii.String("bucketColumns"), }, Columns: []interface{}{ &ColumnProperty{ Name: jsii.String("name"), // the properties below are optional Comment: jsii.String("comment"), Type: jsii.String("type"), }, }, Compressed: jsii.Boolean(false), InputFormat: jsii.String("inputFormat"), Location: jsii.String("location"), NumberOfBuckets: jsii.Number(123), OutputFormat: jsii.String("outputFormat"), Parameters: parameters, SchemaReference: &SchemaReferenceProperty{ SchemaId: &SchemaIdProperty{ RegistryName: jsii.String("registryName"), SchemaArn: jsii.String("schemaArn"), SchemaName: jsii.String("schemaName"), }, SchemaVersionId: jsii.String("schemaVersionId"), SchemaVersionNumber: jsii.Number(123), }, SerdeInfo: &SerdeInfoProperty{ Name: jsii.String("name"), Parameters: parameters, SerializationLibrary: jsii.String("serializationLibrary"), }, SkewedInfo: &SkewedInfoProperty{ SkewedColumnNames: []*string{ jsii.String("skewedColumnNames"), }, SkewedColumnValueLocationMaps: skewedColumnValueLocationMaps, SkewedColumnValues: []*string{ jsii.String("skewedColumnValues"), }, }, SortColumns: []interface{}{ &OrderProperty{ Column: jsii.String("column"), SortOrder: jsii.Number(123), }, }, StoredAsSubDirectories: jsii.Boolean(false), }, TableType: jsii.String("tableType"), TargetTable: &TableIdentifierProperty{ CatalogId: jsii.String("catalogId"), DatabaseName: jsii.String("databaseName"), Name: jsii.String("name"), Region: jsii.String("region"), }, ViewExpandedText: jsii.String("viewExpandedText"), ViewOriginalText: jsii.String("viewOriginalText"), }
type CfnTrigger ¶
type CfnTrigger interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The actions initiated by this trigger. Actions() interface{} SetActions(val interface{}) // 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 // A description of this trigger. Description() *string SetDescription(val *string) // Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires. EventBatchingCondition() interface{} SetEventBatchingCondition(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 the trigger. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The predicate of this trigger, which defines when it will fire. Predicate() interface{} SetPredicate(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 // A `cron` expression used to specify the schedule. Schedule() *string SetSchedule(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created. StartOnCreation() interface{} SetStartOnCreation(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags to use with this trigger. TagsRaw() interface{} SetTagsRaw(val interface{}) // The type of trigger that this is. 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{} // The name of the workflow associated with the trigger. WorkflowName() *string SetWorkflowName(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 `AWS::Glue::Trigger` resource specifies triggers that run AWS Glue jobs.
For more information, see [Triggering Jobs in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/trigger-job.html) and [Trigger Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-trigger.html#aws-glue-api-jobs-trigger-Trigger) in the *AWS Glue Developer Guide* .
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 arguments_ interface{} var tags interface{} cfnTrigger := awscdk.Aws_glue.NewCfnTrigger(this, jsii.String("MyCfnTrigger"), &CfnTriggerProps{ Actions: []interface{}{ &ActionProperty{ Arguments: arguments_, CrawlerName: jsii.String("crawlerName"), JobName: jsii.String("jobName"), NotificationProperty: &NotificationPropertyProperty{ NotifyDelayAfter: jsii.Number(123), }, SecurityConfiguration: jsii.String("securityConfiguration"), Timeout: jsii.Number(123), }, }, Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), EventBatchingCondition: &EventBatchingConditionProperty{ BatchSize: jsii.Number(123), // the properties below are optional BatchWindow: jsii.Number(123), }, Name: jsii.String("name"), Predicate: &PredicateProperty{ Conditions: []interface{}{ &ConditionProperty{ CrawlerName: jsii.String("crawlerName"), CrawlState: jsii.String("crawlState"), JobName: jsii.String("jobName"), LogicalOperator: jsii.String("logicalOperator"), State: jsii.String("state"), }, }, Logical: jsii.String("logical"), }, Schedule: jsii.String("schedule"), StartOnCreation: jsii.Boolean(false), Tags: tags, WorkflowName: jsii.String("workflowName"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html
func NewCfnTrigger ¶
func NewCfnTrigger(scope constructs.Construct, id *string, props *CfnTriggerProps) CfnTrigger
type CfnTriggerProps ¶
type CfnTriggerProps struct { // The actions initiated by this trigger. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-actions // Actions interface{} `field:"required" json:"actions" yaml:"actions"` // The type of trigger that this is. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-type // Type *string `field:"required" json:"type" yaml:"type"` // A description of this trigger. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-description // Description *string `field:"optional" json:"description" yaml:"description"` // Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-eventbatchingcondition // EventBatchingCondition interface{} `field:"optional" json:"eventBatchingCondition" yaml:"eventBatchingCondition"` // The name of the trigger. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-name // Name *string `field:"optional" json:"name" yaml:"name"` // The predicate of this trigger, which defines when it will fire. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-predicate // Predicate interface{} `field:"optional" json:"predicate" yaml:"predicate"` // A `cron` expression used to specify the schedule. // // For more information, see [Time-Based Schedules for Jobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) in the *AWS Glue Developer Guide* . For example, to run something every day at 12:15 UTC, specify `cron(15 12 * * ? *)` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-schedule // Schedule *string `field:"optional" json:"schedule" yaml:"schedule"` // Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created. // // True is not supported for `ON_DEMAND` triggers. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-startoncreation // StartOnCreation interface{} `field:"optional" json:"startOnCreation" yaml:"startOnCreation"` // The tags to use with this trigger. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // The name of the workflow associated with the trigger. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html#cfn-glue-trigger-workflowname // WorkflowName *string `field:"optional" json:"workflowName" yaml:"workflowName"` }
Properties for defining a `CfnTrigger`.
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 arguments_ interface{} var tags interface{} cfnTriggerProps := &CfnTriggerProps{ Actions: []interface{}{ &ActionProperty{ Arguments: arguments_, CrawlerName: jsii.String("crawlerName"), JobName: jsii.String("jobName"), NotificationProperty: &NotificationPropertyProperty{ NotifyDelayAfter: jsii.Number(123), }, SecurityConfiguration: jsii.String("securityConfiguration"), Timeout: jsii.Number(123), }, }, Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), EventBatchingCondition: &EventBatchingConditionProperty{ BatchSize: jsii.Number(123), // the properties below are optional BatchWindow: jsii.Number(123), }, Name: jsii.String("name"), Predicate: &PredicateProperty{ Conditions: []interface{}{ &ConditionProperty{ CrawlerName: jsii.String("crawlerName"), CrawlState: jsii.String("crawlState"), JobName: jsii.String("jobName"), LogicalOperator: jsii.String("logicalOperator"), State: jsii.String("state"), }, }, Logical: jsii.String("logical"), }, Schedule: jsii.String("schedule"), StartOnCreation: jsii.Boolean(false), Tags: tags, WorkflowName: jsii.String("workflowName"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html
type CfnTrigger_ActionProperty ¶
type CfnTrigger_ActionProperty struct { // The job arguments used when this trigger fires. // // For this job run, they replace the default arguments set in the job definition itself. // // You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes. // // For information about how to specify and consume your own job arguments, see [Calling AWS Glue APIs in Python](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) in the *AWS Glue Developer Guide* . // // For information about the key-value pairs that AWS Glue consumes to set up your job, see the [Special Parameters Used by AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) topic in the developer guide. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-arguments // Arguments interface{} `field:"optional" json:"arguments" yaml:"arguments"` // The name of the crawler to be used with this action. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-crawlername // CrawlerName *string `field:"optional" json:"crawlerName" yaml:"crawlerName"` // The name of a job to be executed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-jobname // JobName *string `field:"optional" json:"jobName" yaml:"jobName"` // Specifies configuration properties of a job run notification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-notificationproperty // NotificationProperty interface{} `field:"optional" json:"notificationProperty" yaml:"notificationProperty"` // The name of the `SecurityConfiguration` structure to be used with this action. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-securityconfiguration // SecurityConfiguration *string `field:"optional" json:"securityConfiguration" yaml:"securityConfiguration"` // The `JobRun` timeout in minutes. // // This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-action.html#cfn-glue-trigger-action-timeout // Timeout *float64 `field:"optional" json:"timeout" yaml:"timeout"` }
Defines an action to be initiated by a trigger.
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 arguments_ interface{} actionProperty := &ActionProperty{ Arguments: arguments_, CrawlerName: jsii.String("crawlerName"), JobName: jsii.String("jobName"), NotificationProperty: &NotificationPropertyProperty{ NotifyDelayAfter: jsii.Number(123), }, SecurityConfiguration: jsii.String("securityConfiguration"), Timeout: jsii.Number(123), }
type CfnTrigger_ConditionProperty ¶
type CfnTrigger_ConditionProperty struct { // The name of the crawler to which this condition applies. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-crawlername // CrawlerName *string `field:"optional" json:"crawlerName" yaml:"crawlerName"` // The state of the crawler to which this condition applies. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-crawlstate // CrawlState *string `field:"optional" json:"crawlState" yaml:"crawlState"` // The name of the job whose `JobRuns` this condition applies to, and on which this trigger waits. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-jobname // JobName *string `field:"optional" json:"jobName" yaml:"jobName"` // A logical operator. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-logicaloperator // LogicalOperator *string `field:"optional" json:"logicalOperator" yaml:"logicalOperator"` // The condition state. // // Currently, the values supported are `SUCCEEDED` , `STOPPED` , `TIMEOUT` , and `FAILED` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-condition.html#cfn-glue-trigger-condition-state // State *string `field:"optional" json:"state" yaml:"state"` }
Defines a condition under which a trigger fires.
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" conditionProperty := &ConditionProperty{ CrawlerName: jsii.String("crawlerName"), CrawlState: jsii.String("crawlState"), JobName: jsii.String("jobName"), LogicalOperator: jsii.String("logicalOperator"), State: jsii.String("state"), }
type CfnTrigger_EventBatchingConditionProperty ¶ added in v2.44.0
type CfnTrigger_EventBatchingConditionProperty struct { // Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-eventbatchingcondition.html#cfn-glue-trigger-eventbatchingcondition-batchsize // BatchSize *float64 `field:"required" json:"batchSize" yaml:"batchSize"` // Window of time in seconds after which EventBridge event trigger fires. // // Window starts when first event is received. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-eventbatchingcondition.html#cfn-glue-trigger-eventbatchingcondition-batchwindow // BatchWindow *float64 `field:"optional" json:"batchWindow" yaml:"batchWindow"` }
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
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" eventBatchingConditionProperty := &EventBatchingConditionProperty{ BatchSize: jsii.Number(123), // the properties below are optional BatchWindow: jsii.Number(123), }
type CfnTrigger_NotificationPropertyProperty ¶
type CfnTrigger_NotificationPropertyProperty struct { // After a job run starts, the number of minutes to wait before sending a job run delay notification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-notificationproperty.html#cfn-glue-trigger-notificationproperty-notifydelayafter // NotifyDelayAfter *float64 `field:"optional" json:"notifyDelayAfter" yaml:"notifyDelayAfter"` }
Specifies configuration properties of a job run notification.
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" notificationPropertyProperty := &NotificationPropertyProperty{ NotifyDelayAfter: jsii.Number(123), }
type CfnTrigger_PredicateProperty ¶
type CfnTrigger_PredicateProperty struct { // A list of the conditions that determine when the trigger will fire. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-conditions // Conditions interface{} `field:"optional" json:"conditions" yaml:"conditions"` // An optional field if only one condition is listed. // // If multiple conditions are listed, then this field is required. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-trigger-predicate.html#cfn-glue-trigger-predicate-logical // Logical *string `field:"optional" json:"logical" yaml:"logical"` }
Defines the predicate of the trigger, which determines when it fires.
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" predicateProperty := &PredicateProperty{ Conditions: []interface{}{ &ConditionProperty{ CrawlerName: jsii.String("crawlerName"), CrawlState: jsii.String("crawlState"), JobName: jsii.String("jobName"), LogicalOperator: jsii.String("logicalOperator"), State: jsii.String("state"), }, }, Logical: jsii.String("logical"), }
type CfnUsageProfile ¶ added in v2.161.0
type CfnUsageProfile interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The date and time when the usage profile was created. AttrCreatedOn() *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 Configuration() interface{} SetConfiguration(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of the usage profile. Description() *string SetDescription(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 usage profile. 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 stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags to be applied to this UsageProfiles. 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{}) }
Creates an AWS Glue usage 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" cfnUsageProfile := awscdk.Aws_glue.NewCfnUsageProfile(this, jsii.String("MyCfnUsageProfile"), &CfnUsageProfileProps{ Name: jsii.String("name"), // the properties below are optional Configuration: &ProfileConfigurationProperty{ JobConfiguration: map[string]interface{}{ "jobConfigurationKey": &ConfigurationObjectProperty{ "allowedValues": []*string{ jsii.String("allowedValues"), }, "defaultValue": jsii.String("defaultValue"), "maxValue": jsii.String("maxValue"), "minValue": jsii.String("minValue"), }, }, SessionConfiguration: map[string]interface{}{ "sessionConfigurationKey": &ConfigurationObjectProperty{ "allowedValues": []*string{ jsii.String("allowedValues"), }, "defaultValue": jsii.String("defaultValue"), "maxValue": jsii.String("maxValue"), "minValue": jsii.String("minValue"), }, }, }, Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html
func NewCfnUsageProfile ¶ added in v2.161.0
func NewCfnUsageProfile(scope constructs.Construct, id *string, props *CfnUsageProfileProps) CfnUsageProfile
type CfnUsageProfileProps ¶ added in v2.161.0
type CfnUsageProfileProps struct { // The name of the usage profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html#cfn-glue-usageprofile-name // Name *string `field:"required" json:"name" yaml:"name"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html#cfn-glue-usageprofile-configuration // Configuration interface{} `field:"optional" json:"configuration" yaml:"configuration"` // A description of the usage profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html#cfn-glue-usageprofile-description // Description *string `field:"optional" json:"description" yaml:"description"` // The tags to be applied to this UsageProfiles. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html#cfn-glue-usageprofile-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnUsageProfile`.
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" cfnUsageProfileProps := &CfnUsageProfileProps{ Name: jsii.String("name"), // the properties below are optional Configuration: &ProfileConfigurationProperty{ JobConfiguration: map[string]interface{}{ "jobConfigurationKey": &ConfigurationObjectProperty{ "allowedValues": []*string{ jsii.String("allowedValues"), }, "defaultValue": jsii.String("defaultValue"), "maxValue": jsii.String("maxValue"), "minValue": jsii.String("minValue"), }, }, SessionConfiguration: map[string]interface{}{ "sessionConfigurationKey": &ConfigurationObjectProperty{ "allowedValues": []*string{ jsii.String("allowedValues"), }, "defaultValue": jsii.String("defaultValue"), "maxValue": jsii.String("maxValue"), "minValue": jsii.String("minValue"), }, }, }, Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-usageprofile.html
type CfnUsageProfile_ConfigurationObjectProperty ¶ added in v2.163.0
type CfnUsageProfile_ConfigurationObjectProperty struct { // A list of allowed values for the parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-allowedvalues // AllowedValues *[]*string `field:"optional" json:"allowedValues" yaml:"allowedValues"` // A default value for the parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-defaultvalue // DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"` // A maximum allowed value for the parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-maxvalue // MaxValue *string `field:"optional" json:"maxValue" yaml:"maxValue"` // A minimum allowed value for the parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-configurationobject.html#cfn-glue-usageprofile-configurationobject-minvalue // MinValue *string `field:"optional" json:"minValue" yaml:"minValue"` }
Specifies the values that an admin sets for each job or session parameter configured in a AWS Glue usage 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" configurationObjectProperty := &ConfigurationObjectProperty{ AllowedValues: []*string{ jsii.String("allowedValues"), }, DefaultValue: jsii.String("defaultValue"), MaxValue: jsii.String("maxValue"), MinValue: jsii.String("minValue"), }
type CfnUsageProfile_ProfileConfigurationProperty ¶ added in v2.163.0
type CfnUsageProfile_ProfileConfigurationProperty struct { // A key-value map of configuration parameters for AWS Glue jobs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-profileconfiguration.html#cfn-glue-usageprofile-profileconfiguration-jobconfiguration // JobConfiguration interface{} `field:"optional" json:"jobConfiguration" yaml:"jobConfiguration"` // A key-value map of configuration parameters for AWS Glue sessions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-glue-usageprofile-profileconfiguration.html#cfn-glue-usageprofile-profileconfiguration-sessionconfiguration // SessionConfiguration interface{} `field:"optional" json:"sessionConfiguration" yaml:"sessionConfiguration"` }
Specifies the job and session values that an admin configures in an AWS Glue usage 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" profileConfigurationProperty := &ProfileConfigurationProperty{ JobConfiguration: map[string]interface{}{ "jobConfigurationKey": &ConfigurationObjectProperty{ "allowedValues": []*string{ jsii.String("allowedValues"), }, "defaultValue": jsii.String("defaultValue"), "maxValue": jsii.String("maxValue"), "minValue": jsii.String("minValue"), }, }, SessionConfiguration: map[string]interface{}{ "sessionConfigurationKey": &ConfigurationObjectProperty{ "allowedValues": []*string{ jsii.String("allowedValues"), }, "defaultValue": jsii.String("defaultValue"), "maxValue": jsii.String("maxValue"), "minValue": jsii.String("minValue"), }, }, }
type CfnWorkflow ¶
type CfnWorkflow interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable 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 // A collection of properties to be used as part of each execution of the workflow. DefaultRunProperties() interface{} SetDefaultRunProperties(val interface{}) // A description of the workflow. Description() *string SetDescription(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 // You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. MaxConcurrentRuns() *float64 SetMaxConcurrentRuns(val *float64) // The name of the workflow representing the flow. 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 stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // The tags to use with this workflow. TagsRaw() interface{} SetTagsRaw(val interface{}) // 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::Glue::Workflow` is an AWS Glue resource type that manages AWS Glue workflows.
A workflow is a container for a set of related jobs, crawlers, and triggers in AWS Glue . Using a workflow, you can design a complex multi-job extract, transform, and load (ETL) activity that AWS Glue can execute and track as single 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" var defaultRunProperties interface{} var tags interface{} cfnWorkflow := awscdk.Aws_glue.NewCfnWorkflow(this, jsii.String("MyCfnWorkflow"), &CfnWorkflowProps{ DefaultRunProperties: defaultRunProperties, Description: jsii.String("description"), MaxConcurrentRuns: jsii.Number(123), Name: jsii.String("name"), Tags: tags, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html
func NewCfnWorkflow ¶
func NewCfnWorkflow(scope constructs.Construct, id *string, props *CfnWorkflowProps) CfnWorkflow
type CfnWorkflowProps ¶
type CfnWorkflowProps struct { // A collection of properties to be used as part of each execution of the workflow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-defaultrunproperties // DefaultRunProperties interface{} `field:"optional" json:"defaultRunProperties" yaml:"defaultRunProperties"` // A description of the workflow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-description // Description *string `field:"optional" json:"description" yaml:"description"` // You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. // // If you leave this parameter blank, there is no limit to the number of concurrent workflow runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-maxconcurrentruns // MaxConcurrentRuns *float64 `field:"optional" json:"maxConcurrentRuns" yaml:"maxConcurrentRuns"` // The name of the workflow representing the flow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-name // Name *string `field:"optional" json:"name" yaml:"name"` // The tags to use with this workflow. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html#cfn-glue-workflow-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnWorkflow`.
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 defaultRunProperties interface{} var tags interface{} cfnWorkflowProps := &CfnWorkflowProps{ DefaultRunProperties: defaultRunProperties, Description: jsii.String("description"), MaxConcurrentRuns: jsii.Number(123), Name: jsii.String("name"), Tags: tags, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-workflow.html
Source Files ¶
- CfnClassifier.go
- CfnClassifierProps.go
- CfnClassifier_CsvClassifierProperty.go
- CfnClassifier_GrokClassifierProperty.go
- CfnClassifier_JsonClassifierProperty.go
- CfnClassifier_XMLClassifierProperty.go
- CfnClassifier__checks.go
- CfnConnection.go
- CfnConnectionProps.go
- CfnConnection_ConnectionInputProperty.go
- CfnConnection_PhysicalConnectionRequirementsProperty.go
- CfnConnection__checks.go
- CfnCrawler.go
- CfnCrawlerProps.go
- CfnCrawler_CatalogTargetProperty.go
- CfnCrawler_DeltaTargetProperty.go
- CfnCrawler_DynamoDBTargetProperty.go
- CfnCrawler_IcebergTargetProperty.go
- CfnCrawler_JdbcTargetProperty.go
- CfnCrawler_LakeFormationConfigurationProperty.go
- CfnCrawler_MongoDBTargetProperty.go
- CfnCrawler_RecrawlPolicyProperty.go
- CfnCrawler_S3TargetProperty.go
- CfnCrawler_ScheduleProperty.go
- CfnCrawler_SchemaChangePolicyProperty.go
- CfnCrawler_TargetsProperty.go
- CfnCrawler__checks.go
- CfnCustomEntityType.go
- CfnCustomEntityTypeProps.go
- CfnCustomEntityType__checks.go
- CfnDataCatalogEncryptionSettings.go
- CfnDataCatalogEncryptionSettingsProps.go
- CfnDataCatalogEncryptionSettings_ConnectionPasswordEncryptionProperty.go
- CfnDataCatalogEncryptionSettings_DataCatalogEncryptionSettingsProperty.go
- CfnDataCatalogEncryptionSettings_EncryptionAtRestProperty.go
- CfnDataCatalogEncryptionSettings__checks.go
- CfnDataQualityRuleset.go
- CfnDataQualityRulesetProps.go
- CfnDataQualityRuleset_DataQualityTargetTableProperty.go
- CfnDataQualityRuleset__checks.go
- CfnDatabase.go
- CfnDatabaseProps.go
- CfnDatabase_DataLakePrincipalProperty.go
- CfnDatabase_DatabaseIdentifierProperty.go
- CfnDatabase_DatabaseInputProperty.go
- CfnDatabase_FederatedDatabaseProperty.go
- CfnDatabase_PrincipalPrivilegesProperty.go
- CfnDatabase__checks.go
- CfnDevEndpoint.go
- CfnDevEndpointProps.go
- CfnDevEndpoint__checks.go
- CfnJob.go
- CfnJobProps.go
- CfnJob_ConnectionsListProperty.go
- CfnJob_ExecutionPropertyProperty.go
- CfnJob_JobCommandProperty.go
- CfnJob_NotificationPropertyProperty.go
- CfnJob__checks.go
- CfnMLTransform.go
- CfnMLTransformProps.go
- CfnMLTransform_FindMatchesParametersProperty.go
- CfnMLTransform_GlueTablesProperty.go
- CfnMLTransform_InputRecordTablesProperty.go
- CfnMLTransform_MLUserDataEncryptionProperty.go
- CfnMLTransform_TransformEncryptionProperty.go
- CfnMLTransform_TransformParametersProperty.go
- CfnMLTransform__checks.go
- CfnPartition.go
- CfnPartitionProps.go
- CfnPartition_ColumnProperty.go
- CfnPartition_OrderProperty.go
- CfnPartition_PartitionInputProperty.go
- CfnPartition_SchemaIdProperty.go
- CfnPartition_SchemaReferenceProperty.go
- CfnPartition_SerdeInfoProperty.go
- CfnPartition_SkewedInfoProperty.go
- CfnPartition_StorageDescriptorProperty.go
- CfnPartition__checks.go
- CfnRegistry.go
- CfnRegistryProps.go
- CfnRegistry__checks.go
- CfnSchema.go
- CfnSchemaProps.go
- CfnSchemaVersion.go
- CfnSchemaVersionMetadata.go
- CfnSchemaVersionMetadataProps.go
- CfnSchemaVersionMetadata__checks.go
- CfnSchemaVersionProps.go
- CfnSchemaVersion_SchemaProperty.go
- CfnSchemaVersion__checks.go
- CfnSchema_RegistryProperty.go
- CfnSchema_SchemaVersionProperty.go
- CfnSchema__checks.go
- CfnSecurityConfiguration.go
- CfnSecurityConfigurationProps.go
- CfnSecurityConfiguration_CloudWatchEncryptionProperty.go
- CfnSecurityConfiguration_EncryptionConfigurationProperty.go
- CfnSecurityConfiguration_JobBookmarksEncryptionProperty.go
- CfnSecurityConfiguration_S3EncryptionProperty.go
- CfnSecurityConfiguration__checks.go
- CfnTable.go
- CfnTableOptimizer.go
- CfnTableOptimizerProps.go
- CfnTableOptimizer_TableOptimizerConfigurationProperty.go
- CfnTableOptimizer__checks.go
- CfnTableProps.go
- CfnTable_ColumnProperty.go
- CfnTable_IcebergInputProperty.go
- CfnTable_OpenTableFormatInputProperty.go
- CfnTable_OrderProperty.go
- CfnTable_SchemaIdProperty.go
- CfnTable_SchemaReferenceProperty.go
- CfnTable_SerdeInfoProperty.go
- CfnTable_SkewedInfoProperty.go
- CfnTable_StorageDescriptorProperty.go
- CfnTable_TableIdentifierProperty.go
- CfnTable_TableInputProperty.go
- CfnTable__checks.go
- CfnTrigger.go
- CfnTriggerProps.go
- CfnTrigger_ActionProperty.go
- CfnTrigger_ConditionProperty.go
- CfnTrigger_EventBatchingConditionProperty.go
- CfnTrigger_NotificationPropertyProperty.go
- CfnTrigger_PredicateProperty.go
- CfnTrigger__checks.go
- CfnUsageProfile.go
- CfnUsageProfileProps.go
- CfnUsageProfile_ConfigurationObjectProperty.go
- CfnUsageProfile_ProfileConfigurationProperty.go
- CfnUsageProfile__checks.go
- CfnWorkflow.go
- CfnWorkflowProps.go
- CfnWorkflow__checks.go
- main.go