Documentation
¶
Index ¶
- func CfnGrant_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGrant_IsCfnElement(x interface{}) *bool
- func CfnGrant_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnGrant_IsConstruct(x interface{}) *bool
- func CfnLicense_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLicense_IsCfnElement(x interface{}) *bool
- func CfnLicense_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnLicense_IsConstruct(x interface{}) *bool
- func NewCfnGrant_Override(c CfnGrant, scope constructs.Construct, id *string, props *CfnGrantProps)
- func NewCfnLicense_Override(c CfnLicense, scope constructs.Construct, id *string, props *CfnLicenseProps)
- type CfnGrant
- type CfnGrantProps
- type CfnLicense
- type CfnLicenseProps
- type CfnLicense_BorrowConfigurationProperty
- type CfnLicense_ConsumptionConfigurationProperty
- type CfnLicense_EntitlementProperty
- type CfnLicense_IssuerDataProperty
- type CfnLicense_MetadataProperty
- type CfnLicense_ProvisionalConfigurationProperty
- type CfnLicense_ValidityDateFormatProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnGrant_CFN_RESOURCE_TYPE_NAME ¶
func CfnGrant_CFN_RESOURCE_TYPE_NAME() *string
func CfnGrant_IsCfnElement ¶
func CfnGrant_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 CfnGrant_IsCfnResource ¶
func CfnGrant_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnGrant_IsConstruct ¶
func CfnGrant_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 CfnLicense_CFN_RESOURCE_TYPE_NAME ¶
func CfnLicense_CFN_RESOURCE_TYPE_NAME() *string
func CfnLicense_IsCfnElement ¶
func CfnLicense_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 CfnLicense_IsCfnResource ¶
func CfnLicense_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnLicense_IsConstruct ¶
func CfnLicense_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 NewCfnGrant_Override ¶
func NewCfnGrant_Override(c CfnGrant, scope constructs.Construct, id *string, props *CfnGrantProps)
func NewCfnLicense_Override ¶
func NewCfnLicense_Override(c CfnLicense, scope constructs.Construct, id *string, props *CfnLicenseProps)
Types ¶
type CfnGrant ¶
type CfnGrant interface {
awscdk.CfnResource
awscdk.IInspectable
// Allowed operations for the grant.
AllowedOperations() *[]*string
SetAllowedOperations(val *[]*string)
// The Amazon Resource Name (ARN) of the grant.
AttrGrantArn() *string
// The grant version.
AttrVersion() *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
// Grant name.
GrantName() *string
SetGrantName(val *string)
// Home Region of the grant.
HomeRegion() *string
SetHomeRegion(val *string)
// License ARN.
LicenseArn() *string
SetLicenseArn(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The grant principals.
//
// You can specify one of the following as an Amazon Resource Name (ARN):.
Principals() *[]*string
SetPrincipals(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
// Granted license status.
Status() *string
SetStatus(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Specifies a grant.
A grant shares the use of license entitlements with specific AWS accounts . For more information, see [Granted licenses](https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) in the *AWS License Manager User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnGrant := awscdk.Aws_licensemanager.NewCfnGrant(this, jsii.String("MyCfnGrant"), &CfnGrantProps{
AllowedOperations: []*string{
jsii.String("allowedOperations"),
},
GrantName: jsii.String("grantName"),
HomeRegion: jsii.String("homeRegion"),
LicenseArn: jsii.String("licenseArn"),
Principals: []*string{
jsii.String("principals"),
},
Status: jsii.String("status"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html
func NewCfnGrant ¶
func NewCfnGrant(scope constructs.Construct, id *string, props *CfnGrantProps) CfnGrant
type CfnGrantProps ¶
type CfnGrantProps struct {
// Allowed operations for the grant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-allowedoperations
//
AllowedOperations *[]*string `field:"optional" json:"allowedOperations" yaml:"allowedOperations"`
// Grant name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-grantname
//
GrantName *string `field:"optional" json:"grantName" yaml:"grantName"`
// Home Region of the grant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-homeregion
//
HomeRegion *string `field:"optional" json:"homeRegion" yaml:"homeRegion"`
// License ARN.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-licensearn
//
LicenseArn *string `field:"optional" json:"licenseArn" yaml:"licenseArn"`
// The grant principals. You can specify one of the following as an Amazon Resource Name (ARN):.
//
// - An AWS account, which includes only the account specified.
//
// - An organizational unit (OU), which includes all accounts in the OU.
//
// - An organization, which will include all accounts across your organization.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-principals
//
Principals *[]*string `field:"optional" json:"principals" yaml:"principals"`
// Granted license status.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html#cfn-licensemanager-grant-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
Properties for defining a `CfnGrant`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnGrantProps := &CfnGrantProps{
AllowedOperations: []*string{
jsii.String("allowedOperations"),
},
GrantName: jsii.String("grantName"),
HomeRegion: jsii.String("homeRegion"),
LicenseArn: jsii.String("licenseArn"),
Principals: []*string{
jsii.String("principals"),
},
Status: jsii.String("status"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-grant.html
type CfnLicense ¶
type CfnLicense interface {
awscdk.CfnResource
awscdk.IInspectable
// The Amazon Resource Name (ARN) of the license.
AttrLicenseArn() *string
// The license version.
AttrVersion() *string
// License beneficiary.
Beneficiary() *string
SetBeneficiary(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Configuration for consumption of the license.
ConsumptionConfiguration() interface{}
SetConsumptionConfiguration(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
// License entitlements.
Entitlements() interface{}
SetEntitlements(val interface{})
// Home Region of the license.
HomeRegion() *string
SetHomeRegion(val *string)
// License issuer.
Issuer() interface{}
SetIssuer(val interface{})
// License metadata.
LicenseMetadata() interface{}
SetLicenseMetadata(val interface{})
// License name.
LicenseName() *string
SetLicenseName(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Product name.
ProductName() *string
SetProductName(val *string)
// Product SKU.
ProductSku() *string
SetProductSku(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
// License status.
Status() *string
SetStatus(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Date and time range during which the license is valid, in ISO8601-UTC format.
Validity() interface{}
SetValidity(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{})
}
Specifies a granted license.
Granted licenses are licenses for products that your organization purchased from AWS Marketplace or directly from a seller who integrated their software with managed entitlements. For more information, see [Granted licenses](https://docs.aws.amazon.com/license-manager/latest/userguide/granted-licenses.html) in the *AWS License Manager User Guide* .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnLicense := awscdk.Aws_licensemanager.NewCfnLicense(this, jsii.String("MyCfnLicense"), &CfnLicenseProps{
ConsumptionConfiguration: &ConsumptionConfigurationProperty{
BorrowConfiguration: &BorrowConfigurationProperty{
AllowEarlyCheckIn: jsii.Boolean(false),
MaxTimeToLiveInMinutes: jsii.Number(123),
},
ProvisionalConfiguration: &ProvisionalConfigurationProperty{
MaxTimeToLiveInMinutes: jsii.Number(123),
},
RenewType: jsii.String("renewType"),
},
Entitlements: []interface{}{
&EntitlementProperty{
Name: jsii.String("name"),
Unit: jsii.String("unit"),
// the properties below are optional
AllowCheckIn: jsii.Boolean(false),
MaxCount: jsii.Number(123),
Overage: jsii.Boolean(false),
Value: jsii.String("value"),
},
},
HomeRegion: jsii.String("homeRegion"),
Issuer: &IssuerDataProperty{
Name: jsii.String("name"),
// the properties below are optional
SignKey: jsii.String("signKey"),
},
LicenseName: jsii.String("licenseName"),
ProductName: jsii.String("productName"),
Validity: &ValidityDateFormatProperty{
Begin: jsii.String("begin"),
End: jsii.String("end"),
},
// the properties below are optional
Beneficiary: jsii.String("beneficiary"),
LicenseMetadata: []interface{}{
&MetadataProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
ProductSku: jsii.String("productSku"),
Status: jsii.String("status"),
})
func NewCfnLicense ¶
func NewCfnLicense(scope constructs.Construct, id *string, props *CfnLicenseProps) CfnLicense
type CfnLicenseProps ¶
type CfnLicenseProps struct {
// Configuration for consumption of the license.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-consumptionconfiguration
//
ConsumptionConfiguration interface{} `field:"required" json:"consumptionConfiguration" yaml:"consumptionConfiguration"`
// License entitlements.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-entitlements
//
Entitlements interface{} `field:"required" json:"entitlements" yaml:"entitlements"`
// Home Region of the license.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-homeregion
//
HomeRegion *string `field:"required" json:"homeRegion" yaml:"homeRegion"`
// License issuer.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-issuer
//
Issuer interface{} `field:"required" json:"issuer" yaml:"issuer"`
// License name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-licensename
//
LicenseName *string `field:"required" json:"licenseName" yaml:"licenseName"`
// Product name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-productname
//
ProductName *string `field:"required" json:"productName" yaml:"productName"`
// Date and time range during which the license is valid, in ISO8601-UTC format.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-validity
//
Validity interface{} `field:"required" json:"validity" yaml:"validity"`
// License beneficiary.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-beneficiary
//
Beneficiary *string `field:"optional" json:"beneficiary" yaml:"beneficiary"`
// License metadata.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-licensemetadata
//
LicenseMetadata interface{} `field:"optional" json:"licenseMetadata" yaml:"licenseMetadata"`
// Product SKU.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-productsku
//
ProductSku *string `field:"optional" json:"productSku" yaml:"productSku"`
// License status.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-licensemanager-license.html#cfn-licensemanager-license-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
Properties for defining a `CfnLicense`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnLicenseProps := &CfnLicenseProps{
ConsumptionConfiguration: &ConsumptionConfigurationProperty{
BorrowConfiguration: &BorrowConfigurationProperty{
AllowEarlyCheckIn: jsii.Boolean(false),
MaxTimeToLiveInMinutes: jsii.Number(123),
},
ProvisionalConfiguration: &ProvisionalConfigurationProperty{
MaxTimeToLiveInMinutes: jsii.Number(123),
},
RenewType: jsii.String("renewType"),
},
Entitlements: []interface{}{
&EntitlementProperty{
Name: jsii.String("name"),
Unit: jsii.String("unit"),
// the properties below are optional
AllowCheckIn: jsii.Boolean(false),
MaxCount: jsii.Number(123),
Overage: jsii.Boolean(false),
Value: jsii.String("value"),
},
},
HomeRegion: jsii.String("homeRegion"),
Issuer: &IssuerDataProperty{
Name: jsii.String("name"),
// the properties below are optional
SignKey: jsii.String("signKey"),
},
LicenseName: jsii.String("licenseName"),
ProductName: jsii.String("productName"),
Validity: &ValidityDateFormatProperty{
Begin: jsii.String("begin"),
End: jsii.String("end"),
},
// the properties below are optional
Beneficiary: jsii.String("beneficiary"),
LicenseMetadata: []interface{}{
&MetadataProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
},
},
ProductSku: jsii.String("productSku"),
Status: jsii.String("status"),
}
type CfnLicense_BorrowConfigurationProperty ¶
type CfnLicense_BorrowConfigurationProperty struct {
// Indicates whether early check-ins are allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-borrowconfiguration.html#cfn-licensemanager-license-borrowconfiguration-allowearlycheckin
//
AllowEarlyCheckIn interface{} `field:"required" json:"allowEarlyCheckIn" yaml:"allowEarlyCheckIn"`
// Maximum time for the borrow configuration, in minutes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-borrowconfiguration.html#cfn-licensemanager-license-borrowconfiguration-maxtimetoliveinminutes
//
MaxTimeToLiveInMinutes *float64 `field:"required" json:"maxTimeToLiveInMinutes" yaml:"maxTimeToLiveInMinutes"`
}
Details about a borrow 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"
borrowConfigurationProperty := &BorrowConfigurationProperty{
AllowEarlyCheckIn: jsii.Boolean(false),
MaxTimeToLiveInMinutes: jsii.Number(123),
}
type CfnLicense_ConsumptionConfigurationProperty ¶
type CfnLicense_ConsumptionConfigurationProperty struct {
// Details about a borrow configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-consumptionconfiguration.html#cfn-licensemanager-license-consumptionconfiguration-borrowconfiguration
//
BorrowConfiguration interface{} `field:"optional" json:"borrowConfiguration" yaml:"borrowConfiguration"`
// Details about a provisional configuration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-consumptionconfiguration.html#cfn-licensemanager-license-consumptionconfiguration-provisionalconfiguration
//
ProvisionalConfiguration interface{} `field:"optional" json:"provisionalConfiguration" yaml:"provisionalConfiguration"`
// Renewal frequency.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-consumptionconfiguration.html#cfn-licensemanager-license-consumptionconfiguration-renewtype
//
RenewType *string `field:"optional" json:"renewType" yaml:"renewType"`
}
Details about a consumption 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"
consumptionConfigurationProperty := &ConsumptionConfigurationProperty{
BorrowConfiguration: &BorrowConfigurationProperty{
AllowEarlyCheckIn: jsii.Boolean(false),
MaxTimeToLiveInMinutes: jsii.Number(123),
},
ProvisionalConfiguration: &ProvisionalConfigurationProperty{
MaxTimeToLiveInMinutes: jsii.Number(123),
},
RenewType: jsii.String("renewType"),
}
type CfnLicense_EntitlementProperty ¶
type CfnLicense_EntitlementProperty struct {
// Entitlement name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Entitlement unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-unit
//
Unit *string `field:"required" json:"unit" yaml:"unit"`
// Indicates whether check-ins are allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-allowcheckin
//
AllowCheckIn interface{} `field:"optional" json:"allowCheckIn" yaml:"allowCheckIn"`
// Maximum entitlement count.
//
// Use if the unit is not None.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-maxcount
//
MaxCount *float64 `field:"optional" json:"maxCount" yaml:"maxCount"`
// Indicates whether overages are allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-overage
//
Overage interface{} `field:"optional" json:"overage" yaml:"overage"`
// Entitlement resource.
//
// Use only if the unit is None.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-entitlement.html#cfn-licensemanager-license-entitlement-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
Describes a resource entitled for use with a license.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
entitlementProperty := &EntitlementProperty{
Name: jsii.String("name"),
Unit: jsii.String("unit"),
// the properties below are optional
AllowCheckIn: jsii.Boolean(false),
MaxCount: jsii.Number(123),
Overage: jsii.Boolean(false),
Value: jsii.String("value"),
}
type CfnLicense_IssuerDataProperty ¶
type CfnLicense_IssuerDataProperty struct {
// Issuer name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-issuerdata.html#cfn-licensemanager-license-issuerdata-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// Asymmetric KMS key from AWS Key Management Service .
//
// The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-issuerdata.html#cfn-licensemanager-license-issuerdata-signkey
//
SignKey *string `field:"optional" json:"signKey" yaml:"signKey"`
}
Details associated with the issuer of a license.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
issuerDataProperty := &IssuerDataProperty{
Name: jsii.String("name"),
// the properties below are optional
SignKey: jsii.String("signKey"),
}
type CfnLicense_MetadataProperty ¶
type CfnLicense_MetadataProperty struct {
// The key name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-metadata.html#cfn-licensemanager-license-metadata-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-metadata.html#cfn-licensemanager-license-metadata-value
//
Value *string `field:"required" json:"value" yaml:"value"`
}
Describes key/value pairs.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
metadataProperty := &MetadataProperty{
Name: jsii.String("name"),
Value: jsii.String("value"),
}
type CfnLicense_ProvisionalConfigurationProperty ¶
type CfnLicense_ProvisionalConfigurationProperty struct {
// Maximum time for the provisional configuration, in minutes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-provisionalconfiguration.html#cfn-licensemanager-license-provisionalconfiguration-maxtimetoliveinminutes
//
MaxTimeToLiveInMinutes *float64 `field:"required" json:"maxTimeToLiveInMinutes" yaml:"maxTimeToLiveInMinutes"`
}
Details about a provisional 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"
provisionalConfigurationProperty := &ProvisionalConfigurationProperty{
MaxTimeToLiveInMinutes: jsii.Number(123),
}
type CfnLicense_ValidityDateFormatProperty ¶
type CfnLicense_ValidityDateFormatProperty struct {
// Start of the time range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-validitydateformat.html#cfn-licensemanager-license-validitydateformat-begin
//
Begin *string `field:"required" json:"begin" yaml:"begin"`
// End of the time range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-licensemanager-license-validitydateformat.html#cfn-licensemanager-license-validitydateformat-end
//
End *string `field:"required" json:"end" yaml:"end"`
}
Date and time range during which the license is valid, in ISO8601-UTC format.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
validityDateFormatProperty := &ValidityDateFormatProperty{
Begin: jsii.String("begin"),
End: jsii.String("end"),
}
Source Files
¶
- CfnGrant.go
- CfnGrantProps.go
- CfnGrant__checks.go
- CfnLicense.go
- CfnLicenseProps.go
- CfnLicense_BorrowConfigurationProperty.go
- CfnLicense_ConsumptionConfigurationProperty.go
- CfnLicense_EntitlementProperty.go
- CfnLicense_IssuerDataProperty.go
- CfnLicense_MetadataProperty.go
- CfnLicense_ProvisionalConfigurationProperty.go
- CfnLicense_ValidityDateFormatProperty.go
- CfnLicense__checks.go
- main.go