awslicensemanager

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
  • func NewCfnGrant(scope constructs.Construct, id *string, props *CfnGrantProps) CfnGrant
• type CfnGrantProps
• type CfnLicense
  • func NewCfnLicense(scope constructs.Construct, id *string, props *CfnLicenseProps) CfnLicense
• type CfnLicenseProps
• type CfnLicense_BorrowConfigurationProperty
• type CfnLicense_ConsumptionConfigurationProperty
• type CfnLicense_EntitlementProperty
• type CfnLicense_IssuerDataProperty
• type CfnLicense_MetadataProperty
• type CfnLicense_ProvisionalConfigurationProperty
• type CfnLicense_ValidityDateFormatProperty

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.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

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.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnGrant_Override

func NewCfnGrant_Override(c CfnGrant, scope constructs.Construct, id *string, props *CfnGrantProps)

Create a new `AWS::LicenseManager::Grant`.

func NewCfnLicense_Override

func NewCfnLicense_Override(c CfnLicense, scope constructs.Construct, id *string, props *CfnLicenseProps)

Create a new `AWS::LicenseManager::License`.

Types

type CfnGrant

type CfnGrant interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AllowedOperations() *[]*string
	SetAllowedOperations(val *[]*string)
	AttrGrantArn() *string
	AttrVersion() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	GrantName() *string
	SetGrantName(val *string)
	HomeRegion() *string
	SetHomeRegion(val *string)
	LicenseArn() *string
	SetLicenseArn(val *string)
	LogicalId() *string
	Node() constructs.Node
	Principals() *[]*string
	SetPrincipals(val *[]*string)
	Ref() *string
	Stack() awscdk.Stack
	Status() *string
	SetStatus(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::LicenseManager::Grant`.

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* .

TODO: EXAMPLE

func NewCfnGrant

func NewCfnGrant(scope constructs.Construct, id *string, props *CfnGrantProps) CfnGrant

Create a new `AWS::LicenseManager::Grant`.

type CfnGrantProps

type CfnGrantProps struct {
	// Allowed operations for the grant.
	AllowedOperations *[]*string `json:"allowedOperations" yaml:"allowedOperations"`
	// Grant name.
	GrantName *string `json:"grantName" yaml:"grantName"`
	// Home Region of the grant.
	HomeRegion *string `json:"homeRegion" yaml:"homeRegion"`
	// License ARN.
	LicenseArn *string `json:"licenseArn" yaml:"licenseArn"`
	// The grant principals.
	Principals *[]*string `json:"principals" yaml:"principals"`
	// Granted license status.
	Status *string `json:"status" yaml:"status"`
}

Properties for defining a `CfnGrant`.

TODO: EXAMPLE

type CfnLicense

type CfnLicense interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrLicenseArn() *string
	AttrVersion() *string
	Beneficiary() *string
	SetBeneficiary(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConsumptionConfiguration() interface{}
	SetConsumptionConfiguration(val interface{})
	CreationStack() *[]*string
	Entitlements() interface{}
	SetEntitlements(val interface{})
	HomeRegion() *string
	SetHomeRegion(val *string)
	Issuer() interface{}
	SetIssuer(val interface{})
	LicenseMetadata() interface{}
	SetLicenseMetadata(val interface{})
	LicenseName() *string
	SetLicenseName(val *string)
	LogicalId() *string
	Node() constructs.Node
	ProductName() *string
	SetProductName(val *string)
	ProductSku() *string
	SetProductSku(val *string)
	Ref() *string
	Stack() awscdk.Stack
	Status() *string
	SetStatus(val *string)
	UpdatedProperites() *map[string]interface{}
	Validity() interface{}
	SetValidity(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::LicenseManager::License`.

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* .

TODO: EXAMPLE

func NewCfnLicense

func NewCfnLicense(scope constructs.Construct, id *string, props *CfnLicenseProps) CfnLicense

Create a new `AWS::LicenseManager::License`.

type CfnLicenseProps

type CfnLicenseProps struct {
	// Configuration for consumption of the license.
	ConsumptionConfiguration interface{} `json:"consumptionConfiguration" yaml:"consumptionConfiguration"`
	// License entitlements.
	Entitlements interface{} `json:"entitlements" yaml:"entitlements"`
	// Home Region of the license.
	HomeRegion *string `json:"homeRegion" yaml:"homeRegion"`
	// License issuer.
	Issuer interface{} `json:"issuer" yaml:"issuer"`
	// License name.
	LicenseName *string `json:"licenseName" yaml:"licenseName"`
	// Product name.
	ProductName *string `json:"productName" yaml:"productName"`
	// Date and time range during which the license is valid, in ISO8601-UTC format.
	Validity interface{} `json:"validity" yaml:"validity"`
	// License beneficiary.
	Beneficiary *string `json:"beneficiary" yaml:"beneficiary"`
	// License metadata.
	LicenseMetadata interface{} `json:"licenseMetadata" yaml:"licenseMetadata"`
	// Product SKU.
	ProductSku *string `json:"productSku" yaml:"productSku"`
	// License status.
	Status *string `json:"status" yaml:"status"`
}

Properties for defining a `CfnLicense`.

TODO: EXAMPLE

type CfnLicense_BorrowConfigurationProperty

type CfnLicense_BorrowConfigurationProperty struct {
	// Indicates whether early check-ins are allowed.
	AllowEarlyCheckIn interface{} `json:"allowEarlyCheckIn" yaml:"allowEarlyCheckIn"`
	// Maximum time for the borrow configuration, in minutes.
	MaxTimeToLiveInMinutes *float64 `json:"maxTimeToLiveInMinutes" yaml:"maxTimeToLiveInMinutes"`
}

Details about a borrow configuration.

TODO: EXAMPLE

type CfnLicense_ConsumptionConfigurationProperty

type CfnLicense_ConsumptionConfigurationProperty struct {
	// Details about a borrow configuration.
	BorrowConfiguration interface{} `json:"borrowConfiguration" yaml:"borrowConfiguration"`
	// Details about a provisional configuration.
	ProvisionalConfiguration interface{} `json:"provisionalConfiguration" yaml:"provisionalConfiguration"`
	// Renewal frequency.
	RenewType *string `json:"renewType" yaml:"renewType"`
}

Details about a consumption configuration.

TODO: EXAMPLE

type CfnLicense_EntitlementProperty

type CfnLicense_EntitlementProperty struct {
	// Entitlement name.
	Name *string `json:"name" yaml:"name"`
	// Entitlement unit.
	Unit *string `json:"unit" yaml:"unit"`
	// Indicates whether check-ins are allowed.
	AllowCheckIn interface{} `json:"allowCheckIn" yaml:"allowCheckIn"`
	// Maximum entitlement count.
	//
	// Use if the unit is not None.
	MaxCount *float64 `json:"maxCount" yaml:"maxCount"`
	// Indicates whether overages are allowed.
	Overage interface{} `json:"overage" yaml:"overage"`
	// Entitlement resource.
	//
	// Use only if the unit is None.
	Value *string `json:"value" yaml:"value"`
}

Describes a resource entitled for use with a license.

TODO: EXAMPLE

type CfnLicense_IssuerDataProperty

type CfnLicense_IssuerDataProperty struct {
	// Issuer name.
	Name *string `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.
	SignKey *string `json:"signKey" yaml:"signKey"`
}

Details associated with the issuer of a license.

TODO: EXAMPLE

type CfnLicense_MetadataProperty

type CfnLicense_MetadataProperty struct {
	// The key name.
	Name *string `json:"name" yaml:"name"`
	// The value.
	Value *string `json:"value" yaml:"value"`
}

Describes key/value pairs.

TODO: EXAMPLE

type CfnLicense_ProvisionalConfigurationProperty

type CfnLicense_ProvisionalConfigurationProperty struct {
	// Maximum time for the provisional configuration, in minutes.
	MaxTimeToLiveInMinutes *float64 `json:"maxTimeToLiveInMinutes" yaml:"maxTimeToLiveInMinutes"`
}

Details about a provisional configuration.

TODO: EXAMPLE

type CfnLicense_ValidityDateFormatProperty

type CfnLicense_ValidityDateFormatProperty struct {
	// Start of the time range.
	Begin *string `json:"begin" yaml:"begin"`
	// End of the time range.
	End *string `json:"end" yaml:"end"`
}

Date and time range during which the license is valid, in ISO8601-UTC format.

TODO: EXAMPLE