Documentation ¶
Index ¶
- func CfnDataSource_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataSource_IsCfnElement(x interface{}) *bool
- func CfnDataSource_IsCfnResource(x interface{}) *bool
- func CfnDataSource_IsConstruct(x interface{}) *bool
- func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomain_IsCfnElement(x interface{}) *bool
- func CfnDomain_IsCfnResource(x interface{}) *bool
- func CfnDomain_IsConstruct(x interface{}) *bool
- func CfnEnvironmentBlueprintConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironmentBlueprintConfiguration_IsCfnElement(x interface{}) *bool
- func CfnEnvironmentBlueprintConfiguration_IsCfnResource(x interface{}) *bool
- func CfnEnvironmentBlueprintConfiguration_IsConstruct(x interface{}) *bool
- func CfnEnvironmentProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironmentProfile_IsCfnElement(x interface{}) *bool
- func CfnEnvironmentProfile_IsCfnResource(x interface{}) *bool
- func CfnEnvironmentProfile_IsConstruct(x interface{}) *bool
- func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironment_IsCfnElement(x interface{}) *bool
- func CfnEnvironment_IsCfnResource(x interface{}) *bool
- func CfnEnvironment_IsConstruct(x interface{}) *bool
- func CfnProject_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProject_IsCfnElement(x interface{}) *bool
- func CfnProject_IsCfnResource(x interface{}) *bool
- func CfnProject_IsConstruct(x interface{}) *bool
- func CfnSubscriptionTarget_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubscriptionTarget_IsCfnElement(x interface{}) *bool
- func CfnSubscriptionTarget_IsCfnResource(x interface{}) *bool
- func CfnSubscriptionTarget_IsConstruct(x interface{}) *bool
- func NewCfnDataSource_Override(c CfnDataSource, scope constructs.Construct, id *string, ...)
- func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
- func NewCfnEnvironmentBlueprintConfiguration_Override(c CfnEnvironmentBlueprintConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnEnvironmentProfile_Override(c CfnEnvironmentProfile, scope constructs.Construct, id *string, ...)
- func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, ...)
- func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
- func NewCfnSubscriptionTarget_Override(c CfnSubscriptionTarget, scope constructs.Construct, id *string, ...)
- type CfnDataSource
- type CfnDataSourceProps
- type CfnDataSource_DataSourceConfigurationInputProperty
- type CfnDataSource_FilterExpressionProperty
- type CfnDataSource_FormInputProperty
- type CfnDataSource_GlueRunConfigurationInputProperty
- type CfnDataSource_RecommendationConfigurationProperty
- type CfnDataSource_RedshiftClusterStorageProperty
- type CfnDataSource_RedshiftCredentialConfigurationProperty
- type CfnDataSource_RedshiftRunConfigurationInputProperty
- type CfnDataSource_RedshiftServerlessStorageProperty
- type CfnDataSource_RedshiftStorageProperty
- type CfnDataSource_RelationalFilterConfigurationProperty
- type CfnDataSource_ScheduleConfigurationProperty
- type CfnDomain
- type CfnDomainProps
- type CfnDomain_SingleSignOnProperty
- type CfnEnvironment
- type CfnEnvironmentBlueprintConfiguration
- type CfnEnvironmentBlueprintConfigurationProps
- type CfnEnvironmentBlueprintConfiguration_RegionalParameterProperty
- type CfnEnvironmentProfile
- type CfnEnvironmentProfileProps
- type CfnEnvironmentProfile_EnvironmentParameterProperty
- type CfnEnvironmentProps
- type CfnEnvironment_EnvironmentParameterProperty
- type CfnProject
- type CfnProjectProps
- type CfnSubscriptionTarget
- type CfnSubscriptionTargetProps
- type CfnSubscriptionTarget_SubscriptionTargetFormProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnDataSource_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataSource_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataSource_IsCfnElement ¶
func CfnDataSource_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDataSource_IsCfnResource ¶
func CfnDataSource_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDataSource_IsConstruct ¶
func CfnDataSource_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnDomain_CFN_RESOURCE_TYPE_NAME ¶
func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomain_IsCfnElement ¶
func CfnDomain_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDomain_IsCfnResource ¶
func CfnDomain_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDomain_IsConstruct ¶
func CfnDomain_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnEnvironmentBlueprintConfiguration_CFN_RESOURCE_TYPE_NAME ¶
func CfnEnvironmentBlueprintConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnvironmentBlueprintConfiguration_IsCfnElement ¶
func CfnEnvironmentBlueprintConfiguration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnEnvironmentBlueprintConfiguration_IsCfnResource ¶
func CfnEnvironmentBlueprintConfiguration_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEnvironmentBlueprintConfiguration_IsConstruct ¶
func CfnEnvironmentBlueprintConfiguration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnEnvironmentProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnEnvironmentProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnvironmentProfile_IsCfnElement ¶
func CfnEnvironmentProfile_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnEnvironmentProfile_IsCfnResource ¶
func CfnEnvironmentProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEnvironmentProfile_IsConstruct ¶
func CfnEnvironmentProfile_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnEnvironment_CFN_RESOURCE_TYPE_NAME ¶
func CfnEnvironment_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnvironment_IsCfnElement ¶
func CfnEnvironment_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnEnvironment_IsCfnResource ¶
func CfnEnvironment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEnvironment_IsConstruct ¶
func CfnEnvironment_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnProject_CFN_RESOURCE_TYPE_NAME ¶
func CfnProject_CFN_RESOURCE_TYPE_NAME() *string
func CfnProject_IsCfnElement ¶
func CfnProject_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnProject_IsCfnResource ¶
func CfnProject_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnProject_IsConstruct ¶
func CfnProject_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSubscriptionTarget_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubscriptionTarget_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubscriptionTarget_IsCfnElement ¶
func CfnSubscriptionTarget_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSubscriptionTarget_IsCfnResource ¶
func CfnSubscriptionTarget_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSubscriptionTarget_IsConstruct ¶
func CfnSubscriptionTarget_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnDataSource_Override ¶
func NewCfnDataSource_Override(c CfnDataSource, scope constructs.Construct, id *string, props *CfnDataSourceProps)
func NewCfnDomain_Override ¶
func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
func NewCfnEnvironmentBlueprintConfiguration_Override ¶
func NewCfnEnvironmentBlueprintConfiguration_Override(c CfnEnvironmentBlueprintConfiguration, scope constructs.Construct, id *string, props *CfnEnvironmentBlueprintConfigurationProps)
func NewCfnEnvironmentProfile_Override ¶
func NewCfnEnvironmentProfile_Override(c CfnEnvironmentProfile, scope constructs.Construct, id *string, props *CfnEnvironmentProfileProps)
func NewCfnEnvironment_Override ¶
func NewCfnEnvironment_Override(c CfnEnvironment, scope constructs.Construct, id *string, props *CfnEnvironmentProps)
func NewCfnProject_Override ¶
func NewCfnProject_Override(c CfnProject, scope constructs.Construct, id *string, props *CfnProjectProps)
func NewCfnSubscriptionTarget_Override ¶
func NewCfnSubscriptionTarget_Override(c CfnSubscriptionTarget, scope constructs.Construct, id *string, props *CfnSubscriptionTargetProps)
Types ¶
type CfnDataSource ¶
type CfnDataSource interface { awscdk.CfnResource awscdk.IInspectable // The metadata forms that are to be attached to the assets that this data source works with. AssetFormsInput() interface{} SetAssetFormsInput(val interface{}) // The timestamp of when the data source was created. AttrCreatedAt() *string // The ID of the Amazon DataZone domain where the data source is created. AttrDomainId() *string // The unique identifier of the Amazon DataZone environment to which the data source publishes assets. AttrEnvironmentId() *string // The unique identifier of the data source. AttrId() *string // The number of assets created by the data source during its last run. AttrLastRunAssetCount() awscdk.IResolvable // The timestamp that specifies when the data source was last run. AttrLastRunAt() *string // The status of the last run of this data source. AttrLastRunStatus() *string // The ID of the Amazon DataZone project to which the data source is added. AttrProjectId() *string // The status of the data source. AttrStatus() *string // The timestamp of when this data source was updated. AttrUpdatedAt() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Specifies the configuration of the data source. 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 // The description of the data source. Description() *string SetDescription(val *string) // The ID of the Amazon DataZone domain where the data source is created. DomainIdentifier() *string SetDomainIdentifier(val *string) // Specifies whether the data source is enabled. EnableSetting() *string SetEnableSetting(val *string) // The unique identifier of the Amazon DataZone environment to which the data source publishes assets. EnvironmentIdentifier() *string SetEnvironmentIdentifier(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of the data source. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The identifier of the Amazon DataZone project in which you want to add the data source. ProjectIdentifier() *string SetProjectIdentifier(val *string) // Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. PublishOnImport() interface{} SetPublishOnImport(val interface{}) // The recommendation to be updated as part of the UpdateDataSource action. Recommendation() interface{} SetRecommendation(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The schedule of the data source runs. Schedule() interface{} SetSchedule(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The type of the data source. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::DataZone::DataSource Resource Type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDataSource := awscdk.Aws_datazone.NewCfnDataSource(this, jsii.String("MyCfnDataSource"), &CfnDataSourceProps{ DomainIdentifier: jsii.String("domainIdentifier"), EnvironmentIdentifier: jsii.String("environmentIdentifier"), Name: jsii.String("name"), ProjectIdentifier: jsii.String("projectIdentifier"), Type: jsii.String("type"), // the properties below are optional AssetFormsInput: []interface{}{ &FormInputProperty{ FormName: jsii.String("formName"), // the properties below are optional Content: jsii.String("content"), TypeIdentifier: jsii.String("typeIdentifier"), TypeRevision: jsii.String("typeRevision"), }, }, Configuration: &DataSourceConfigurationInputProperty{ GlueRunConfiguration: &GlueRunConfigurationInputProperty{ RelationalFilterConfigurations: []interface{}{ &RelationalFilterConfigurationProperty{ DatabaseName: jsii.String("databaseName"), // the properties below are optional FilterExpressions: []interface{}{ &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }, }, SchemaName: jsii.String("schemaName"), }, }, // the properties below are optional DataAccessRole: jsii.String("dataAccessRole"), }, RedshiftRunConfiguration: &RedshiftRunConfigurationInputProperty{ RedshiftCredentialConfiguration: &RedshiftCredentialConfigurationProperty{ SecretManagerArn: jsii.String("secretManagerArn"), }, RedshiftStorage: &RedshiftStorageProperty{ RedshiftClusterSource: &RedshiftClusterStorageProperty{ ClusterName: jsii.String("clusterName"), }, RedshiftServerlessSource: &RedshiftServerlessStorageProperty{ WorkgroupName: jsii.String("workgroupName"), }, }, RelationalFilterConfigurations: []interface{}{ &RelationalFilterConfigurationProperty{ DatabaseName: jsii.String("databaseName"), // the properties below are optional FilterExpressions: []interface{}{ &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }, }, SchemaName: jsii.String("schemaName"), }, }, // the properties below are optional DataAccessRole: jsii.String("dataAccessRole"), }, }, Description: jsii.String("description"), EnableSetting: jsii.String("enableSetting"), PublishOnImport: jsii.Boolean(false), Recommendation: &RecommendationConfigurationProperty{ EnableBusinessNameGeneration: jsii.Boolean(false), }, Schedule: &ScheduleConfigurationProperty{ Schedule: jsii.String("schedule"), Timezone: jsii.String("timezone"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html
func NewCfnDataSource ¶
func NewCfnDataSource(scope constructs.Construct, id *string, props *CfnDataSourceProps) CfnDataSource
type CfnDataSourceProps ¶
type CfnDataSourceProps struct { // The ID of the Amazon DataZone domain where the data source is created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-domainidentifier // DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"` // The unique identifier of the Amazon DataZone environment to which the data source publishes assets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-environmentidentifier // EnvironmentIdentifier *string `field:"required" json:"environmentIdentifier" yaml:"environmentIdentifier"` // The name of the data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-name // Name *string `field:"required" json:"name" yaml:"name"` // The identifier of the Amazon DataZone project in which you want to add the data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-projectidentifier // ProjectIdentifier *string `field:"required" json:"projectIdentifier" yaml:"projectIdentifier"` // The type of the data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-type // Type *string `field:"required" json:"type" yaml:"type"` // The metadata forms that are to be attached to the assets that this data source works with. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-assetformsinput // AssetFormsInput interface{} `field:"optional" json:"assetFormsInput" yaml:"assetFormsInput"` // Specifies the configuration of the data source. // // It can be set to either glueRunConfiguration or redshiftRunConfiguration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-configuration // Configuration interface{} `field:"optional" json:"configuration" yaml:"configuration"` // The description of the data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-description // Description *string `field:"optional" json:"description" yaml:"description"` // Specifies whether the data source is enabled. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-enablesetting // EnableSetting *string `field:"optional" json:"enableSetting" yaml:"enableSetting"` // Specifies whether the assets that this data source creates in the inventory are to be also automatically published to the catalog. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-publishonimport // PublishOnImport interface{} `field:"optional" json:"publishOnImport" yaml:"publishOnImport"` // The recommendation to be updated as part of the UpdateDataSource action. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-recommendation // Recommendation interface{} `field:"optional" json:"recommendation" yaml:"recommendation"` // The schedule of the data source runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html#cfn-datazone-datasource-schedule // Schedule interface{} `field:"optional" json:"schedule" yaml:"schedule"` }
Properties for defining a `CfnDataSource`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDataSourceProps := &CfnDataSourceProps{ DomainIdentifier: jsii.String("domainIdentifier"), EnvironmentIdentifier: jsii.String("environmentIdentifier"), Name: jsii.String("name"), ProjectIdentifier: jsii.String("projectIdentifier"), Type: jsii.String("type"), // the properties below are optional AssetFormsInput: []interface{}{ &FormInputProperty{ FormName: jsii.String("formName"), // the properties below are optional Content: jsii.String("content"), TypeIdentifier: jsii.String("typeIdentifier"), TypeRevision: jsii.String("typeRevision"), }, }, Configuration: &DataSourceConfigurationInputProperty{ GlueRunConfiguration: &GlueRunConfigurationInputProperty{ RelationalFilterConfigurations: []interface{}{ &RelationalFilterConfigurationProperty{ DatabaseName: jsii.String("databaseName"), // the properties below are optional FilterExpressions: []interface{}{ &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }, }, SchemaName: jsii.String("schemaName"), }, }, // the properties below are optional DataAccessRole: jsii.String("dataAccessRole"), }, RedshiftRunConfiguration: &RedshiftRunConfigurationInputProperty{ RedshiftCredentialConfiguration: &RedshiftCredentialConfigurationProperty{ SecretManagerArn: jsii.String("secretManagerArn"), }, RedshiftStorage: &RedshiftStorageProperty{ RedshiftClusterSource: &RedshiftClusterStorageProperty{ ClusterName: jsii.String("clusterName"), }, RedshiftServerlessSource: &RedshiftServerlessStorageProperty{ WorkgroupName: jsii.String("workgroupName"), }, }, RelationalFilterConfigurations: []interface{}{ &RelationalFilterConfigurationProperty{ DatabaseName: jsii.String("databaseName"), // the properties below are optional FilterExpressions: []interface{}{ &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }, }, SchemaName: jsii.String("schemaName"), }, }, // the properties below are optional DataAccessRole: jsii.String("dataAccessRole"), }, }, Description: jsii.String("description"), EnableSetting: jsii.String("enableSetting"), PublishOnImport: jsii.Boolean(false), Recommendation: &RecommendationConfigurationProperty{ EnableBusinessNameGeneration: jsii.Boolean(false), }, Schedule: &ScheduleConfigurationProperty{ Schedule: jsii.String("schedule"), Timezone: jsii.String("timezone"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-datasource.html
type CfnDataSource_DataSourceConfigurationInputProperty ¶
type CfnDataSource_DataSourceConfigurationInputProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-gluerunconfiguration // GlueRunConfiguration interface{} `field:"optional" json:"glueRunConfiguration" yaml:"glueRunConfiguration"` // The configuration details of the Amazon Redshift data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-datasourceconfigurationinput.html#cfn-datazone-datasource-datasourceconfigurationinput-redshiftrunconfiguration // RedshiftRunConfiguration interface{} `field:"optional" json:"redshiftRunConfiguration" yaml:"redshiftRunConfiguration"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataSourceConfigurationInputProperty := &DataSourceConfigurationInputProperty{ GlueRunConfiguration: &GlueRunConfigurationInputProperty{ RelationalFilterConfigurations: []interface{}{ &RelationalFilterConfigurationProperty{ DatabaseName: jsii.String("databaseName"), // the properties below are optional FilterExpressions: []interface{}{ &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }, }, SchemaName: jsii.String("schemaName"), }, }, // the properties below are optional DataAccessRole: jsii.String("dataAccessRole"), }, RedshiftRunConfiguration: &RedshiftRunConfigurationInputProperty{ RedshiftCredentialConfiguration: &RedshiftCredentialConfigurationProperty{ SecretManagerArn: jsii.String("secretManagerArn"), }, RedshiftStorage: &RedshiftStorageProperty{ RedshiftClusterSource: &RedshiftClusterStorageProperty{ ClusterName: jsii.String("clusterName"), }, RedshiftServerlessSource: &RedshiftServerlessStorageProperty{ WorkgroupName: jsii.String("workgroupName"), }, }, RelationalFilterConfigurations: []interface{}{ &RelationalFilterConfigurationProperty{ DatabaseName: jsii.String("databaseName"), // the properties below are optional FilterExpressions: []interface{}{ &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }, }, SchemaName: jsii.String("schemaName"), }, }, // the properties below are optional DataAccessRole: jsii.String("dataAccessRole"), }, }
type CfnDataSource_FilterExpressionProperty ¶
type CfnDataSource_FilterExpressionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.html#cfn-datazone-datasource-filterexpression-expression // Expression *string `field:"required" json:"expression" yaml:"expression"` // The search filter expression type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-filterexpression.html#cfn-datazone-datasource-filterexpression-type // Type *string `field:"required" json:"type" yaml:"type"` }
The search filter expression.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" filterExpressionProperty := &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }
type CfnDataSource_FormInputProperty ¶
type CfnDataSource_FormInputProperty struct { // The name of the metadata form. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-formname // FormName *string `field:"required" json:"formName" yaml:"formName"` // The content of the metadata form. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-content // Content *string `field:"optional" json:"content" yaml:"content"` // The ID of the metadata form type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-typeidentifier // TypeIdentifier *string `field:"optional" json:"typeIdentifier" yaml:"typeIdentifier"` // The revision of the metadata form type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-forminput.html#cfn-datazone-datasource-forminput-typerevision // TypeRevision *string `field:"optional" json:"typeRevision" yaml:"typeRevision"` }
The details of a metadata form.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" formInputProperty := &FormInputProperty{ FormName: jsii.String("formName"), // the properties below are optional Content: jsii.String("content"), TypeIdentifier: jsii.String("typeIdentifier"), TypeRevision: jsii.String("typeRevision"), }
type CfnDataSource_GlueRunConfigurationInputProperty ¶
type CfnDataSource_GlueRunConfigurationInputProperty struct { // The relational filter configurations included in the configuration details of the AWS Glue data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-relationalfilterconfigurations // RelationalFilterConfigurations interface{} `field:"required" json:"relationalFilterConfigurations" yaml:"relationalFilterConfigurations"` // The data access role included in the configuration details of the AWS Glue data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-gluerunconfigurationinput.html#cfn-datazone-datasource-gluerunconfigurationinput-dataaccessrole // DataAccessRole *string `field:"optional" json:"dataAccessRole" yaml:"dataAccessRole"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" glueRunConfigurationInputProperty := &GlueRunConfigurationInputProperty{ RelationalFilterConfigurations: []interface{}{ &RelationalFilterConfigurationProperty{ DatabaseName: jsii.String("databaseName"), // the properties below are optional FilterExpressions: []interface{}{ &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }, }, SchemaName: jsii.String("schemaName"), }, }, // the properties below are optional DataAccessRole: jsii.String("dataAccessRole"), }
type CfnDataSource_RecommendationConfigurationProperty ¶
type CfnDataSource_RecommendationConfigurationProperty struct { // Specifies whether automatic business name generation is to be enabled or not as part of the recommendation configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-recommendationconfiguration.html#cfn-datazone-datasource-recommendationconfiguration-enablebusinessnamegeneration // EnableBusinessNameGeneration interface{} `field:"optional" json:"enableBusinessNameGeneration" yaml:"enableBusinessNameGeneration"` }
The recommendation to be updated as part of the UpdateDataSource action.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" recommendationConfigurationProperty := &RecommendationConfigurationProperty{ EnableBusinessNameGeneration: jsii.Boolean(false), }
type CfnDataSource_RedshiftClusterStorageProperty ¶
type CfnDataSource_RedshiftClusterStorageProperty struct { // The name of an Amazon Redshift cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftclusterstorage.html#cfn-datazone-datasource-redshiftclusterstorage-clustername // ClusterName *string `field:"required" json:"clusterName" yaml:"clusterName"` }
The name of an Amazon Redshift cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" redshiftClusterStorageProperty := &RedshiftClusterStorageProperty{ ClusterName: jsii.String("clusterName"), }
type CfnDataSource_RedshiftCredentialConfigurationProperty ¶
type CfnDataSource_RedshiftCredentialConfigurationProperty struct { // The ARN of a secret manager for an Amazon Redshift cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftcredentialconfiguration.html#cfn-datazone-datasource-redshiftcredentialconfiguration-secretmanagerarn // SecretManagerArn *string `field:"required" json:"secretManagerArn" yaml:"secretManagerArn"` }
The ARN of a secret manager for an Amazon Redshift cluster.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" redshiftCredentialConfigurationProperty := &RedshiftCredentialConfigurationProperty{ SecretManagerArn: jsii.String("secretManagerArn"), }
type CfnDataSource_RedshiftRunConfigurationInputProperty ¶
type CfnDataSource_RedshiftRunConfigurationInputProperty struct { // The ARN of a secret manager for an Amazon Redshift cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftcredentialconfiguration // RedshiftCredentialConfiguration interface{} `field:"required" json:"redshiftCredentialConfiguration" yaml:"redshiftCredentialConfiguration"` // The details of the Amazon Redshift storage as part of the configuration of an Amazon Redshift data source run. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-redshiftstorage // RedshiftStorage interface{} `field:"required" json:"redshiftStorage" yaml:"redshiftStorage"` // The relational filter configurations included in the configuration details of the Amazon Redshift data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-relationalfilterconfigurations // RelationalFilterConfigurations interface{} `field:"required" json:"relationalFilterConfigurations" yaml:"relationalFilterConfigurations"` // The data access role included in the configuration details of the AWS Glue data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftrunconfigurationinput.html#cfn-datazone-datasource-redshiftrunconfigurationinput-dataaccessrole // DataAccessRole *string `field:"optional" json:"dataAccessRole" yaml:"dataAccessRole"` }
The configuration details of the Amazon Redshift data source.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" redshiftRunConfigurationInputProperty := &RedshiftRunConfigurationInputProperty{ RedshiftCredentialConfiguration: &RedshiftCredentialConfigurationProperty{ SecretManagerArn: jsii.String("secretManagerArn"), }, RedshiftStorage: &RedshiftStorageProperty{ RedshiftClusterSource: &RedshiftClusterStorageProperty{ ClusterName: jsii.String("clusterName"), }, RedshiftServerlessSource: &RedshiftServerlessStorageProperty{ WorkgroupName: jsii.String("workgroupName"), }, }, RelationalFilterConfigurations: []interface{}{ &RelationalFilterConfigurationProperty{ DatabaseName: jsii.String("databaseName"), // the properties below are optional FilterExpressions: []interface{}{ &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }, }, SchemaName: jsii.String("schemaName"), }, }, // the properties below are optional DataAccessRole: jsii.String("dataAccessRole"), }
type CfnDataSource_RedshiftServerlessStorageProperty ¶
type CfnDataSource_RedshiftServerlessStorageProperty struct { // The name of the Amazon Redshift Serverless workgroup. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftserverlessstorage.html#cfn-datazone-datasource-redshiftserverlessstorage-workgroupname // WorkgroupName *string `field:"required" json:"workgroupName" yaml:"workgroupName"` }
The details of the Amazon Redshift Serverless workgroup storage.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" redshiftServerlessStorageProperty := &RedshiftServerlessStorageProperty{ WorkgroupName: jsii.String("workgroupName"), }
type CfnDataSource_RedshiftStorageProperty ¶
type CfnDataSource_RedshiftStorageProperty struct { // The name of an Amazon Redshift cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.html#cfn-datazone-datasource-redshiftstorage-redshiftclustersource // RedshiftClusterSource interface{} `field:"optional" json:"redshiftClusterSource" yaml:"redshiftClusterSource"` // The details of the Amazon Redshift Serverless workgroup storage. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-redshiftstorage.html#cfn-datazone-datasource-redshiftstorage-redshiftserverlesssource // RedshiftServerlessSource interface{} `field:"optional" json:"redshiftServerlessSource" yaml:"redshiftServerlessSource"` }
The details of the Amazon Redshift cluster source.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" redshiftStorageProperty := &RedshiftStorageProperty{ RedshiftClusterSource: &RedshiftClusterStorageProperty{ ClusterName: jsii.String("clusterName"), }, RedshiftServerlessSource: &RedshiftServerlessStorageProperty{ WorkgroupName: jsii.String("workgroupName"), }, }
type CfnDataSource_RelationalFilterConfigurationProperty ¶
type CfnDataSource_RelationalFilterConfigurationProperty struct { // The database name specified in the relational filter configuration for the data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-databasename // DatabaseName *string `field:"required" json:"databaseName" yaml:"databaseName"` // The filter expressions specified in the relational filter configuration for the data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-filterexpressions // FilterExpressions interface{} `field:"optional" json:"filterExpressions" yaml:"filterExpressions"` // The schema name specified in the relational filter configuration for the data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-relationalfilterconfiguration.html#cfn-datazone-datasource-relationalfilterconfiguration-schemaname // SchemaName *string `field:"optional" json:"schemaName" yaml:"schemaName"` }
The relational filter configuration for the data source.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" relationalFilterConfigurationProperty := &RelationalFilterConfigurationProperty{ DatabaseName: jsii.String("databaseName"), // the properties below are optional FilterExpressions: []interface{}{ &FilterExpressionProperty{ Expression: jsii.String("expression"), Type: jsii.String("type"), }, }, SchemaName: jsii.String("schemaName"), }
type CfnDataSource_ScheduleConfigurationProperty ¶
type CfnDataSource_ScheduleConfigurationProperty struct { // The schedule of the data source runs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.html#cfn-datazone-datasource-scheduleconfiguration-schedule // Schedule *string `field:"optional" json:"schedule" yaml:"schedule"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-datasource-scheduleconfiguration.html#cfn-datazone-datasource-scheduleconfiguration-timezone // Timezone *string `field:"optional" json:"timezone" yaml:"timezone"` }
The schedule of the data source runs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" scheduleConfigurationProperty := &ScheduleConfigurationProperty{ Schedule: jsii.String("schedule"), Timezone: jsii.String("timezone"), }
type CfnDomain ¶
type CfnDomain interface { awscdk.CfnResource awscdk.IInspectable // The ARN of the Amazon DataZone domain. AttrArn() *string // The timestamp of when the Amazon DataZone domain was last updated. AttrCreatedAt() *string // The id of the Amazon DataZone domain. AttrId() *string // The timestamp of when the Amazon DataZone domain was last updated. AttrLastUpdatedAt() *string // The identifier of the AWS account that manages the domain. AttrManagedAccountId() *string // The URL of the data portal for this Amazon DataZone domain. AttrPortalUrl() *string // The status of the Amazon DataZone domain. AttrStatus() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the Amazon DataZone domain. Description() *string SetDescription(val *string) // The domain execution role that is created when an Amazon DataZone domain is created. DomainExecutionRole() *string SetDomainExecutionRole(val *string) // The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. KmsKeyIdentifier() *string SetKmsKeyIdentifier(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of the Amazon DataZone domain. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The single-sign on configuration of the Amazon DataZone domain. SingleSignOn() interface{} SetSingleSignOn(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The tags specified for the Amazon DataZone domain. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A domain is an organizing entity for connecting together assets, users, and their projects.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDomain := awscdk.Aws_datazone.NewCfnDomain(this, jsii.String("MyCfnDomain"), &CfnDomainProps{ DomainExecutionRole: jsii.String("domainExecutionRole"), Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), KmsKeyIdentifier: jsii.String("kmsKeyIdentifier"), SingleSignOn: &SingleSignOnProperty{ Type: jsii.String("type"), UserAssignment: jsii.String("userAssignment"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html
func NewCfnDomain ¶
func NewCfnDomain(scope constructs.Construct, id *string, props *CfnDomainProps) CfnDomain
type CfnDomainProps ¶
type CfnDomainProps struct { // The domain execution role that is created when an Amazon DataZone domain is created. // // The domain execution role is created in the AWS account that houses the Amazon DataZone domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-domainexecutionrole // DomainExecutionRole *string `field:"required" json:"domainExecutionRole" yaml:"domainExecutionRole"` // The name of the Amazon DataZone domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-name // Name *string `field:"required" json:"name" yaml:"name"` // The description of the Amazon DataZone domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-description // Description *string `field:"optional" json:"description" yaml:"description"` // The identifier of the AWS Key Management Service (KMS) key that is used to encrypt the Amazon DataZone domain, metadata, and reporting data. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-kmskeyidentifier // KmsKeyIdentifier *string `field:"optional" json:"kmsKeyIdentifier" yaml:"kmsKeyIdentifier"` // The single-sign on configuration of the Amazon DataZone domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-singlesignon // SingleSignOn interface{} `field:"optional" json:"singleSignOn" yaml:"singleSignOn"` // The tags specified for the Amazon DataZone domain. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html#cfn-datazone-domain-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDomain`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDomainProps := &CfnDomainProps{ DomainExecutionRole: jsii.String("domainExecutionRole"), Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), KmsKeyIdentifier: jsii.String("kmsKeyIdentifier"), SingleSignOn: &SingleSignOnProperty{ Type: jsii.String("type"), UserAssignment: jsii.String("userAssignment"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-domain.html
type CfnDomain_SingleSignOnProperty ¶
type CfnDomain_SingleSignOnProperty struct { // The type of single sign-on in Amazon DataZone. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-domain-singlesignon.html#cfn-datazone-domain-singlesignon-type // Type *string `field:"optional" json:"type" yaml:"type"` // The single sign-on user assignment in Amazon DataZone. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-domain-singlesignon.html#cfn-datazone-domain-singlesignon-userassignment // UserAssignment *string `field:"optional" json:"userAssignment" yaml:"userAssignment"` }
The single-sign on configuration of the Amazon DataZone domain.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" singleSignOnProperty := &SingleSignOnProperty{ Type: jsii.String("type"), UserAssignment: jsii.String("userAssignment"), }
type CfnEnvironment ¶
type CfnEnvironment interface { awscdk.CfnResource awscdk.IInspectable // The AWS account in which the Amazon DataZone environment is created. AttrAwsAccountId() *string // The AWS region in which the Amazon DataZone environment is created. AttrAwsAccountRegion() *string // The timestamp of when the environment was created. AttrCreatedAt() *string // The Amazon DataZone user who created the environment. AttrCreatedBy() *string // The identifier of the Amazon DataZone domain in which the environment is created. AttrDomainId() *string // The ID of the blueprint with which the Amazon DataZone environment was created. AttrEnvironmentBlueprintId() *string // The ID of the environment profile with which the Amazon DataZone environment was created. AttrEnvironmentProfileId() *string // The ID of the Amazon DataZone environment. AttrId() *string // The ID of the Amazon DataZone project in which the environment is created. AttrProjectId() *string // The provider of the Amazon DataZone environment. AttrProvider() *string // The status of the Amazon DataZone environment. AttrStatus() *string // The timestamp of when the environment was updated. AttrUpdatedAt() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the Amazon DataZone environment. Description() *string SetDescription(val *string) // The identifier of the Amazon DataZone domain in which the environment would be created. DomainIdentifier() *string SetDomainIdentifier(val *string) // The ID of the environment profile with which the Amazon DataZone environment would be created. EnvironmentProfileIdentifier() *string SetEnvironmentProfileIdentifier(val *string) // The glossary terms that can be used in the Amazon DataZone environment. GlossaryTerms() *[]*string SetGlossaryTerms(val *[]*string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of the environment. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The ID of the Amazon DataZone project in which the environment would be created. ProjectIdentifier() *string SetProjectIdentifier(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The user parameters of the Amazon DataZone environment. UserParameters() interface{} SetUserParameters(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::DataZone::Environment Resource Type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEnvironment := awscdk.Aws_datazone.NewCfnEnvironment(this, jsii.String("MyCfnEnvironment"), &CfnEnvironmentProps{ DomainIdentifier: jsii.String("domainIdentifier"), EnvironmentProfileIdentifier: jsii.String("environmentProfileIdentifier"), Name: jsii.String("name"), ProjectIdentifier: jsii.String("projectIdentifier"), // the properties below are optional Description: jsii.String("description"), GlossaryTerms: []*string{ jsii.String("glossaryTerms"), }, UserParameters: []interface{}{ &EnvironmentParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html
func NewCfnEnvironment ¶
func NewCfnEnvironment(scope constructs.Construct, id *string, props *CfnEnvironmentProps) CfnEnvironment
type CfnEnvironmentBlueprintConfiguration ¶
type CfnEnvironmentBlueprintConfiguration interface { awscdk.CfnResource awscdk.IInspectable AttrCreatedAt() *string AttrDomainId() *string AttrEnvironmentBlueprintId() *string AttrUpdatedAt() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string DomainIdentifier() *string SetDomainIdentifier(val *string) EnabledRegions() *[]*string SetEnabledRegions(val *[]*string) EnvironmentBlueprintIdentifier() *string SetEnvironmentBlueprintIdentifier(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 ManageAccessRoleArn() *string SetManageAccessRoleArn(val *string) // The tree node. Node() constructs.Node ProvisioningRoleArn() *string SetProvisioningRoleArn(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string RegionalParameters() interface{} SetRegionalParameters(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Definition of AWS::DataZone::EnvironmentBlueprintConfiguration Resource Type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEnvironmentBlueprintConfiguration := awscdk.Aws_datazone.NewCfnEnvironmentBlueprintConfiguration(this, jsii.String("MyCfnEnvironmentBlueprintConfiguration"), &CfnEnvironmentBlueprintConfigurationProps{ DomainIdentifier: jsii.String("domainIdentifier"), EnabledRegions: []*string{ jsii.String("enabledRegions"), }, EnvironmentBlueprintIdentifier: jsii.String("environmentBlueprintIdentifier"), // the properties below are optional ManageAccessRoleArn: jsii.String("manageAccessRoleArn"), ProvisioningRoleArn: jsii.String("provisioningRoleArn"), RegionalParameters: []interface{}{ &RegionalParameterProperty{ Parameters: map[string]*string{ "parametersKey": jsii.String("parameters"), }, Region: jsii.String("region"), }, }, })
func NewCfnEnvironmentBlueprintConfiguration ¶
func NewCfnEnvironmentBlueprintConfiguration(scope constructs.Construct, id *string, props *CfnEnvironmentBlueprintConfigurationProps) CfnEnvironmentBlueprintConfiguration
type CfnEnvironmentBlueprintConfigurationProps ¶
type CfnEnvironmentBlueprintConfigurationProps struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-domainidentifier // DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-enabledregions // EnabledRegions *[]*string `field:"required" json:"enabledRegions" yaml:"enabledRegions"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-environmentblueprintidentifier // EnvironmentBlueprintIdentifier *string `field:"required" json:"environmentBlueprintIdentifier" yaml:"environmentBlueprintIdentifier"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-manageaccessrolearn // ManageAccessRoleArn *string `field:"optional" json:"manageAccessRoleArn" yaml:"manageAccessRoleArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-provisioningrolearn // ProvisioningRoleArn *string `field:"optional" json:"provisioningRoleArn" yaml:"provisioningRoleArn"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentblueprintconfiguration.html#cfn-datazone-environmentblueprintconfiguration-regionalparameters // RegionalParameters interface{} `field:"optional" json:"regionalParameters" yaml:"regionalParameters"` }
Properties for defining a `CfnEnvironmentBlueprintConfiguration`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEnvironmentBlueprintConfigurationProps := &CfnEnvironmentBlueprintConfigurationProps{ DomainIdentifier: jsii.String("domainIdentifier"), EnabledRegions: []*string{ jsii.String("enabledRegions"), }, EnvironmentBlueprintIdentifier: jsii.String("environmentBlueprintIdentifier"), // the properties below are optional ManageAccessRoleArn: jsii.String("manageAccessRoleArn"), ProvisioningRoleArn: jsii.String("provisioningRoleArn"), RegionalParameters: []interface{}{ &RegionalParameterProperty{ Parameters: map[string]*string{ "parametersKey": jsii.String("parameters"), }, Region: jsii.String("region"), }, }, }
type CfnEnvironmentBlueprintConfiguration_RegionalParameterProperty ¶
type CfnEnvironmentBlueprintConfiguration_RegionalParameterProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-regionalparameter.html#cfn-datazone-environmentblueprintconfiguration-regionalparameter-parameters // Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentblueprintconfiguration-regionalparameter.html#cfn-datazone-environmentblueprintconfiguration-regionalparameter-region // Region *string `field:"optional" json:"region" yaml:"region"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" regionalParameterProperty := &RegionalParameterProperty{ Parameters: map[string]*string{ "parametersKey": jsii.String("parameters"), }, Region: jsii.String("region"), }
type CfnEnvironmentProfile ¶
type CfnEnvironmentProfile interface { awscdk.CfnResource awscdk.IInspectable // The timestamp of when this environment profile was created. AttrCreatedAt() *string // The Amazon DataZone user who created this environment profile. AttrCreatedBy() *string // The ID of the Amazon DataZone domain in which this environment profile is created. AttrDomainId() *string // The ID of the blueprint with which this environment profile is created. AttrEnvironmentBlueprintId() *string // The ID of this Amazon DataZone environment profile. AttrId() *string // The identifier of the project in which to create the environment profile. AttrProjectId() *string // The timestamp of when this environment profile was updated. AttrUpdatedAt() *string // The AWS account in which the Amazon DataZone environment is created. AwsAccountId() *string SetAwsAccountId(val *string) // The AWS region in which this environment profile is created. AwsAccountRegion() *string SetAwsAccountRegion(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of this Amazon DataZone environment profile. Description() *string SetDescription(val *string) // The ID of the Amazon DataZone domain in which this environment profile is created. DomainIdentifier() *string SetDomainIdentifier(val *string) // The ID of the blueprint with which this environment profile is created. EnvironmentBlueprintIdentifier() *string SetEnvironmentBlueprintIdentifier(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 this Amazon DataZone environment profile. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The identifier of the project in which to create the environment profile. ProjectIdentifier() *string SetProjectIdentifier(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The user parameters of this Amazon DataZone environment profile. UserParameters() interface{} SetUserParameters(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
AWS Datazone Environment Profile is pre-configured set of resources and blueprints that provide reusable templates for creating environments.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEnvironmentProfile := awscdk.Aws_datazone.NewCfnEnvironmentProfile(this, jsii.String("MyCfnEnvironmentProfile"), &CfnEnvironmentProfileProps{ DomainIdentifier: jsii.String("domainIdentifier"), EnvironmentBlueprintIdentifier: jsii.String("environmentBlueprintIdentifier"), Name: jsii.String("name"), ProjectIdentifier: jsii.String("projectIdentifier"), // the properties below are optional AwsAccountId: jsii.String("awsAccountId"), AwsAccountRegion: jsii.String("awsAccountRegion"), Description: jsii.String("description"), UserParameters: []interface{}{ &EnvironmentParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, })
func NewCfnEnvironmentProfile ¶
func NewCfnEnvironmentProfile(scope constructs.Construct, id *string, props *CfnEnvironmentProfileProps) CfnEnvironmentProfile
type CfnEnvironmentProfileProps ¶
type CfnEnvironmentProfileProps struct { // The ID of the Amazon DataZone domain in which this environment profile is created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-domainidentifier // DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"` // The ID of the blueprint with which this environment profile is created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-environmentblueprintidentifier // EnvironmentBlueprintIdentifier *string `field:"required" json:"environmentBlueprintIdentifier" yaml:"environmentBlueprintIdentifier"` // The name of this Amazon DataZone environment profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-name // Name *string `field:"required" json:"name" yaml:"name"` // The identifier of the project in which to create the environment profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-projectidentifier // ProjectIdentifier *string `field:"required" json:"projectIdentifier" yaml:"projectIdentifier"` // The AWS account in which the Amazon DataZone environment is created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-awsaccountid // AwsAccountId *string `field:"optional" json:"awsAccountId" yaml:"awsAccountId"` // The AWS region in which this environment profile is created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-awsaccountregion // AwsAccountRegion *string `field:"optional" json:"awsAccountRegion" yaml:"awsAccountRegion"` // The description of this Amazon DataZone environment profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-description // Description *string `field:"optional" json:"description" yaml:"description"` // The user parameters of this Amazon DataZone environment profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environmentprofile.html#cfn-datazone-environmentprofile-userparameters // UserParameters interface{} `field:"optional" json:"userParameters" yaml:"userParameters"` }
Properties for defining a `CfnEnvironmentProfile`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEnvironmentProfileProps := &CfnEnvironmentProfileProps{ DomainIdentifier: jsii.String("domainIdentifier"), EnvironmentBlueprintIdentifier: jsii.String("environmentBlueprintIdentifier"), Name: jsii.String("name"), ProjectIdentifier: jsii.String("projectIdentifier"), // the properties below are optional AwsAccountId: jsii.String("awsAccountId"), AwsAccountRegion: jsii.String("awsAccountRegion"), Description: jsii.String("description"), UserParameters: []interface{}{ &EnvironmentParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, }
type CfnEnvironmentProfile_EnvironmentParameterProperty ¶
type CfnEnvironmentProfile_EnvironmentParameterProperty struct { // The name of an environment profile parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentprofile-environmentparameter.html#cfn-datazone-environmentprofile-environmentparameter-name // Name *string `field:"optional" json:"name" yaml:"name"` // The value of an environment profile parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environmentprofile-environmentparameter.html#cfn-datazone-environmentprofile-environmentparameter-value // Value *string `field:"optional" json:"value" yaml:"value"` }
The parameter details of an environment profile.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" environmentParameterProperty := &EnvironmentParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }
type CfnEnvironmentProps ¶
type CfnEnvironmentProps struct { // The identifier of the Amazon DataZone domain in which the environment would be created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-domainidentifier // DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"` // The ID of the environment profile with which the Amazon DataZone environment would be created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-environmentprofileidentifier // EnvironmentProfileIdentifier *string `field:"required" json:"environmentProfileIdentifier" yaml:"environmentProfileIdentifier"` // The name of the environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-name // Name *string `field:"required" json:"name" yaml:"name"` // The ID of the Amazon DataZone project in which the environment would be created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-projectidentifier // ProjectIdentifier *string `field:"required" json:"projectIdentifier" yaml:"projectIdentifier"` // The description of the Amazon DataZone environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-description // Description *string `field:"optional" json:"description" yaml:"description"` // The glossary terms that can be used in the Amazon DataZone environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-glossaryterms // GlossaryTerms *[]*string `field:"optional" json:"glossaryTerms" yaml:"glossaryTerms"` // The user parameters of the Amazon DataZone environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html#cfn-datazone-environment-userparameters // UserParameters interface{} `field:"optional" json:"userParameters" yaml:"userParameters"` }
Properties for defining a `CfnEnvironment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEnvironmentProps := &CfnEnvironmentProps{ DomainIdentifier: jsii.String("domainIdentifier"), EnvironmentProfileIdentifier: jsii.String("environmentProfileIdentifier"), Name: jsii.String("name"), ProjectIdentifier: jsii.String("projectIdentifier"), // the properties below are optional Description: jsii.String("description"), GlossaryTerms: []*string{ jsii.String("glossaryTerms"), }, UserParameters: []interface{}{ &EnvironmentParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-environment.html
type CfnEnvironment_EnvironmentParameterProperty ¶
type CfnEnvironment_EnvironmentParameterProperty struct { // The name of an environment parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environment-environmentparameter.html#cfn-datazone-environment-environmentparameter-name // Name *string `field:"optional" json:"name" yaml:"name"` // The value of an environment parameter. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-environment-environmentparameter.html#cfn-datazone-environment-environmentparameter-value // Value *string `field:"optional" json:"value" yaml:"value"` }
The parameter details of an environment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" environmentParameterProperty := &EnvironmentParameterProperty{ Name: jsii.String("name"), Value: jsii.String("value"), }
type CfnProject ¶
type CfnProject interface { awscdk.CfnResource awscdk.IInspectable // The timestamp of when the project was created. AttrCreatedAt() *string // The Amazon DataZone user who created the project. AttrCreatedBy() *string // The identifier of the Amazon DataZone domain in which the project was created. AttrDomainId() *string // The ID of the Amazon DataZone project. AttrId() *string // The timestamp of when the project was last updated. AttrLastUpdatedAt() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The description of the Amazon DataZone project. Description() *string SetDescription(val *string) // The ID of the Amazon DataZone domain in which this project is created. DomainIdentifier() *string SetDomainIdentifier(val *string) // The glossary terms that can be used in this Amazon DataZone project. GlossaryTerms() *[]*string SetGlossaryTerms(val *[]*string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of the Amazon DataZone project. 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{}) }
Amazon DataZone projects are business use case–based groupings of people, assets (data), and tools used to simplify access to the AWS analytics.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnProject := awscdk.Aws_datazone.NewCfnProject(this, jsii.String("MyCfnProject"), &CfnProjectProps{ DomainIdentifier: jsii.String("domainIdentifier"), Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), GlossaryTerms: []*string{ jsii.String("glossaryTerms"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html
func NewCfnProject ¶
func NewCfnProject(scope constructs.Construct, id *string, props *CfnProjectProps) CfnProject
type CfnProjectProps ¶
type CfnProjectProps struct { // The ID of the Amazon DataZone domain in which this project is created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-domainidentifier // DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"` // The name of the Amazon DataZone project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-name // Name *string `field:"required" json:"name" yaml:"name"` // The description of the Amazon DataZone project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-description // Description *string `field:"optional" json:"description" yaml:"description"` // The glossary terms that can be used in this Amazon DataZone project. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html#cfn-datazone-project-glossaryterms // GlossaryTerms *[]*string `field:"optional" json:"glossaryTerms" yaml:"glossaryTerms"` }
Properties for defining a `CfnProject`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnProjectProps := &CfnProjectProps{ DomainIdentifier: jsii.String("domainIdentifier"), Name: jsii.String("name"), // the properties below are optional Description: jsii.String("description"), GlossaryTerms: []*string{ jsii.String("glossaryTerms"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-project.html
type CfnSubscriptionTarget ¶
type CfnSubscriptionTarget interface { awscdk.CfnResource awscdk.IInspectable // The asset types that can be included in the subscription target. ApplicableAssetTypes() *[]*string SetApplicableAssetTypes(val *[]*string) // The timestamp of when the subscription target was created. AttrCreatedAt() *string // The Amazon DataZone user who created the subscription target. AttrCreatedBy() *string // The ID of the Amazon DataZone domain in which subscription target is created. AttrDomainId() *string // The ID of the environment in which subscription target is created. AttrEnvironmentId() *string // The ID of the subscription target. AttrId() *string // The identifier of the project specified in the subscription target. AttrProjectId() *string // The timestamp of when the subscription target was updated. AttrUpdatedAt() *string // The Amazon DataZone user who updated the subscription target. AttrUpdatedBy() *string // The authorized principals of the subscription target. AuthorizedPrincipals() *[]*string SetAuthorizedPrincipals(val *[]*string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The ID of the Amazon DataZone domain in which subscription target would be created. DomainIdentifier() *string SetDomainIdentifier(val *string) // The ID of the environment in which subscription target would be created. EnvironmentIdentifier() *string SetEnvironmentIdentifier(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The manage access role that is used to create the subscription target. ManageAccessRole() *string SetManageAccessRole(val *string) // The name of the subscription target. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The provider of the subscription target. Provider() *string SetProvider(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The configuration of the subscription target. SubscriptionTargetConfig() interface{} SetSubscriptionTargetConfig(val interface{}) // The type of the subscription target. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Subscription targets enables one to access the data to which you have subscribed in your projects.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSubscriptionTarget := awscdk.Aws_datazone.NewCfnSubscriptionTarget(this, jsii.String("MyCfnSubscriptionTarget"), &CfnSubscriptionTargetProps{ ApplicableAssetTypes: []*string{ jsii.String("applicableAssetTypes"), }, AuthorizedPrincipals: []*string{ jsii.String("authorizedPrincipals"), }, DomainIdentifier: jsii.String("domainIdentifier"), EnvironmentIdentifier: jsii.String("environmentIdentifier"), ManageAccessRole: jsii.String("manageAccessRole"), Name: jsii.String("name"), SubscriptionTargetConfig: []interface{}{ &SubscriptionTargetFormProperty{ Content: jsii.String("content"), FormName: jsii.String("formName"), }, }, Type: jsii.String("type"), // the properties below are optional Provider: jsii.String("provider"), })
func NewCfnSubscriptionTarget ¶
func NewCfnSubscriptionTarget(scope constructs.Construct, id *string, props *CfnSubscriptionTargetProps) CfnSubscriptionTarget
type CfnSubscriptionTargetProps ¶
type CfnSubscriptionTargetProps struct { // The asset types that can be included in the subscription target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-applicableassettypes // ApplicableAssetTypes *[]*string `field:"required" json:"applicableAssetTypes" yaml:"applicableAssetTypes"` // The authorized principals of the subscription target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-authorizedprincipals // AuthorizedPrincipals *[]*string `field:"required" json:"authorizedPrincipals" yaml:"authorizedPrincipals"` // The ID of the Amazon DataZone domain in which subscription target would be created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-domainidentifier // DomainIdentifier *string `field:"required" json:"domainIdentifier" yaml:"domainIdentifier"` // The ID of the environment in which subscription target would be created. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-environmentidentifier // EnvironmentIdentifier *string `field:"required" json:"environmentIdentifier" yaml:"environmentIdentifier"` // The manage access role that is used to create the subscription target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-manageaccessrole // ManageAccessRole *string `field:"required" json:"manageAccessRole" yaml:"manageAccessRole"` // The name of the subscription target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-name // Name *string `field:"required" json:"name" yaml:"name"` // The configuration of the subscription target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-subscriptiontargetconfig // SubscriptionTargetConfig interface{} `field:"required" json:"subscriptionTargetConfig" yaml:"subscriptionTargetConfig"` // The type of the subscription target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-type // Type *string `field:"required" json:"type" yaml:"type"` // The provider of the subscription target. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-datazone-subscriptiontarget.html#cfn-datazone-subscriptiontarget-provider // Provider *string `field:"optional" json:"provider" yaml:"provider"` }
Properties for defining a `CfnSubscriptionTarget`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSubscriptionTargetProps := &CfnSubscriptionTargetProps{ ApplicableAssetTypes: []*string{ jsii.String("applicableAssetTypes"), }, AuthorizedPrincipals: []*string{ jsii.String("authorizedPrincipals"), }, DomainIdentifier: jsii.String("domainIdentifier"), EnvironmentIdentifier: jsii.String("environmentIdentifier"), ManageAccessRole: jsii.String("manageAccessRole"), Name: jsii.String("name"), SubscriptionTargetConfig: []interface{}{ &SubscriptionTargetFormProperty{ Content: jsii.String("content"), FormName: jsii.String("formName"), }, }, Type: jsii.String("type"), // the properties below are optional Provider: jsii.String("provider"), }
type CfnSubscriptionTarget_SubscriptionTargetFormProperty ¶
type CfnSubscriptionTarget_SubscriptionTargetFormProperty struct { // The content of the subscription target configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-subscriptiontarget-subscriptiontargetform.html#cfn-datazone-subscriptiontarget-subscriptiontargetform-content // Content *string `field:"required" json:"content" yaml:"content"` // The form name included in the subscription target configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-datazone-subscriptiontarget-subscriptiontargetform.html#cfn-datazone-subscriptiontarget-subscriptiontargetform-formname // FormName *string `field:"required" json:"formName" yaml:"formName"` }
The details of the subscription target configuration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" subscriptionTargetFormProperty := &SubscriptionTargetFormProperty{ Content: jsii.String("content"), FormName: jsii.String("formName"), }
Source Files ¶
- CfnDataSource.go
- CfnDataSourceProps.go
- CfnDataSource_DataSourceConfigurationInputProperty.go
- CfnDataSource_FilterExpressionProperty.go
- CfnDataSource_FormInputProperty.go
- CfnDataSource_GlueRunConfigurationInputProperty.go
- CfnDataSource_RecommendationConfigurationProperty.go
- CfnDataSource_RedshiftClusterStorageProperty.go
- CfnDataSource_RedshiftCredentialConfigurationProperty.go
- CfnDataSource_RedshiftRunConfigurationInputProperty.go
- CfnDataSource_RedshiftServerlessStorageProperty.go
- CfnDataSource_RedshiftStorageProperty.go
- CfnDataSource_RelationalFilterConfigurationProperty.go
- CfnDataSource_ScheduleConfigurationProperty.go
- CfnDataSource__checks.go
- CfnDomain.go
- CfnDomainProps.go
- CfnDomain_SingleSignOnProperty.go
- CfnDomain__checks.go
- CfnEnvironment.go
- CfnEnvironmentBlueprintConfiguration.go
- CfnEnvironmentBlueprintConfigurationProps.go
- CfnEnvironmentBlueprintConfiguration_RegionalParameterProperty.go
- CfnEnvironmentBlueprintConfiguration__checks.go
- CfnEnvironmentProfile.go
- CfnEnvironmentProfileProps.go
- CfnEnvironmentProfile_EnvironmentParameterProperty.go
- CfnEnvironmentProfile__checks.go
- CfnEnvironmentProps.go
- CfnEnvironment_EnvironmentParameterProperty.go
- CfnEnvironment__checks.go
- CfnProject.go
- CfnProjectProps.go
- CfnProject__checks.go
- CfnSubscriptionTarget.go
- CfnSubscriptionTargetProps.go
- CfnSubscriptionTarget_SubscriptionTargetFormProperty.go
- CfnSubscriptionTarget__checks.go
- main.go