Documentation ¶
Index ¶
- func CfnFarm_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFarm_IsCfnElement(x interface{}) *bool
- func CfnFarm_IsCfnResource(x interface{}) *bool
- func CfnFarm_IsConstruct(x interface{}) *bool
- func CfnFleet_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFleet_IsCfnElement(x interface{}) *bool
- func CfnFleet_IsCfnResource(x interface{}) *bool
- func CfnFleet_IsConstruct(x interface{}) *bool
- func CfnLicenseEndpoint_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLicenseEndpoint_IsCfnElement(x interface{}) *bool
- func CfnLicenseEndpoint_IsCfnResource(x interface{}) *bool
- func CfnLicenseEndpoint_IsConstruct(x interface{}) *bool
- func CfnMeteredProduct_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMeteredProduct_IsCfnElement(x interface{}) *bool
- func CfnMeteredProduct_IsCfnResource(x interface{}) *bool
- func CfnMeteredProduct_IsConstruct(x interface{}) *bool
- func CfnQueueEnvironment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnQueueEnvironment_IsCfnElement(x interface{}) *bool
- func CfnQueueEnvironment_IsCfnResource(x interface{}) *bool
- func CfnQueueEnvironment_IsConstruct(x interface{}) *bool
- func CfnQueueFleetAssociation_CFN_RESOURCE_TYPE_NAME() *string
- func CfnQueueFleetAssociation_IsCfnElement(x interface{}) *bool
- func CfnQueueFleetAssociation_IsCfnResource(x interface{}) *bool
- func CfnQueueFleetAssociation_IsConstruct(x interface{}) *bool
- func CfnQueue_CFN_RESOURCE_TYPE_NAME() *string
- func CfnQueue_IsCfnElement(x interface{}) *bool
- func CfnQueue_IsCfnResource(x interface{}) *bool
- func CfnQueue_IsConstruct(x interface{}) *bool
- func CfnStorageProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStorageProfile_IsCfnElement(x interface{}) *bool
- func CfnStorageProfile_IsCfnResource(x interface{}) *bool
- func CfnStorageProfile_IsConstruct(x interface{}) *bool
- func NewCfnFarm_Override(c CfnFarm, scope constructs.Construct, id *string, props *CfnFarmProps)
- func NewCfnFleet_Override(c CfnFleet, scope constructs.Construct, id *string, props *CfnFleetProps)
- func NewCfnLicenseEndpoint_Override(c CfnLicenseEndpoint, scope constructs.Construct, id *string, ...)
- func NewCfnMeteredProduct_Override(c CfnMeteredProduct, scope constructs.Construct, id *string, ...)
- func NewCfnQueueEnvironment_Override(c CfnQueueEnvironment, scope constructs.Construct, id *string, ...)
- func NewCfnQueueFleetAssociation_Override(c CfnQueueFleetAssociation, scope constructs.Construct, id *string, ...)
- func NewCfnQueue_Override(c CfnQueue, scope constructs.Construct, id *string, props *CfnQueueProps)
- func NewCfnStorageProfile_Override(c CfnStorageProfile, scope constructs.Construct, id *string, ...)
- type CfnFarm
- type CfnFarmProps
- type CfnFleet
- type CfnFleetProps
- type CfnFleet_AcceleratorCountRangeProperty
- type CfnFleet_AcceleratorTotalMemoryMiBRangeProperty
- type CfnFleet_CustomerManagedFleetConfigurationProperty
- type CfnFleet_CustomerManagedWorkerCapabilitiesProperty
- type CfnFleet_Ec2EbsVolumeProperty
- type CfnFleet_FleetAmountCapabilityProperty
- type CfnFleet_FleetAttributeCapabilityProperty
- type CfnFleet_FleetCapabilitiesProperty
- type CfnFleet_FleetConfigurationProperty
- type CfnFleet_MemoryMiBRangeProperty
- type CfnFleet_ServiceManagedEc2FleetConfigurationProperty
- type CfnFleet_ServiceManagedEc2InstanceCapabilitiesProperty
- type CfnFleet_ServiceManagedEc2InstanceMarketOptionsProperty
- type CfnFleet_VCpuCountRangeProperty
- type CfnLicenseEndpoint
- type CfnLicenseEndpointProps
- type CfnMeteredProduct
- type CfnMeteredProductProps
- type CfnQueue
- type CfnQueueEnvironment
- type CfnQueueEnvironmentProps
- type CfnQueueFleetAssociation
- type CfnQueueFleetAssociationProps
- type CfnQueueProps
- type CfnQueue_JobAttachmentSettingsProperty
- type CfnQueue_JobRunAsUserProperty
- type CfnQueue_PosixUserProperty
- type CfnQueue_WindowsUserProperty
- type CfnStorageProfile
- type CfnStorageProfileProps
- type CfnStorageProfile_FileSystemLocationProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnFarm_CFN_RESOURCE_TYPE_NAME ¶
func CfnFarm_CFN_RESOURCE_TYPE_NAME() *string
func CfnFarm_IsCfnElement ¶
func CfnFarm_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 CfnFarm_IsCfnResource ¶
func CfnFarm_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFarm_IsConstruct ¶
func CfnFarm_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 CfnFleet_CFN_RESOURCE_TYPE_NAME ¶
func CfnFleet_CFN_RESOURCE_TYPE_NAME() *string
func CfnFleet_IsCfnElement ¶
func CfnFleet_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 CfnFleet_IsCfnResource ¶
func CfnFleet_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFleet_IsConstruct ¶
func CfnFleet_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 CfnLicenseEndpoint_CFN_RESOURCE_TYPE_NAME ¶
func CfnLicenseEndpoint_CFN_RESOURCE_TYPE_NAME() *string
func CfnLicenseEndpoint_IsCfnElement ¶
func CfnLicenseEndpoint_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 CfnLicenseEndpoint_IsCfnResource ¶
func CfnLicenseEndpoint_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLicenseEndpoint_IsConstruct ¶
func CfnLicenseEndpoint_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 CfnMeteredProduct_CFN_RESOURCE_TYPE_NAME ¶
func CfnMeteredProduct_CFN_RESOURCE_TYPE_NAME() *string
func CfnMeteredProduct_IsCfnElement ¶
func CfnMeteredProduct_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 CfnMeteredProduct_IsCfnResource ¶
func CfnMeteredProduct_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMeteredProduct_IsConstruct ¶
func CfnMeteredProduct_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 CfnQueueEnvironment_CFN_RESOURCE_TYPE_NAME ¶
func CfnQueueEnvironment_CFN_RESOURCE_TYPE_NAME() *string
func CfnQueueEnvironment_IsCfnElement ¶
func CfnQueueEnvironment_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 CfnQueueEnvironment_IsCfnResource ¶
func CfnQueueEnvironment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnQueueEnvironment_IsConstruct ¶
func CfnQueueEnvironment_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 CfnQueueFleetAssociation_CFN_RESOURCE_TYPE_NAME ¶
func CfnQueueFleetAssociation_CFN_RESOURCE_TYPE_NAME() *string
func CfnQueueFleetAssociation_IsCfnElement ¶
func CfnQueueFleetAssociation_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 CfnQueueFleetAssociation_IsCfnResource ¶
func CfnQueueFleetAssociation_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnQueueFleetAssociation_IsConstruct ¶
func CfnQueueFleetAssociation_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 CfnQueue_CFN_RESOURCE_TYPE_NAME ¶
func CfnQueue_CFN_RESOURCE_TYPE_NAME() *string
func CfnQueue_IsCfnElement ¶
func CfnQueue_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 CfnQueue_IsCfnResource ¶
func CfnQueue_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnQueue_IsConstruct ¶
func CfnQueue_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 CfnStorageProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnStorageProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnStorageProfile_IsCfnElement ¶
func CfnStorageProfile_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 CfnStorageProfile_IsCfnResource ¶
func CfnStorageProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStorageProfile_IsConstruct ¶
func CfnStorageProfile_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 NewCfnFarm_Override ¶
func NewCfnFarm_Override(c CfnFarm, scope constructs.Construct, id *string, props *CfnFarmProps)
func NewCfnFleet_Override ¶
func NewCfnFleet_Override(c CfnFleet, scope constructs.Construct, id *string, props *CfnFleetProps)
func NewCfnLicenseEndpoint_Override ¶
func NewCfnLicenseEndpoint_Override(c CfnLicenseEndpoint, scope constructs.Construct, id *string, props *CfnLicenseEndpointProps)
func NewCfnMeteredProduct_Override ¶
func NewCfnMeteredProduct_Override(c CfnMeteredProduct, scope constructs.Construct, id *string, props *CfnMeteredProductProps)
func NewCfnQueueEnvironment_Override ¶
func NewCfnQueueEnvironment_Override(c CfnQueueEnvironment, scope constructs.Construct, id *string, props *CfnQueueEnvironmentProps)
func NewCfnQueueFleetAssociation_Override ¶
func NewCfnQueueFleetAssociation_Override(c CfnQueueFleetAssociation, scope constructs.Construct, id *string, props *CfnQueueFleetAssociationProps)
func NewCfnQueue_Override ¶
func NewCfnQueue_Override(c CfnQueue, scope constructs.Construct, id *string, props *CfnQueueProps)
func NewCfnStorageProfile_Override ¶
func NewCfnStorageProfile_Override(c CfnStorageProfile, scope constructs.Construct, id *string, props *CfnStorageProfileProps)
Types ¶
type CfnFarm ¶
type CfnFarm interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) assigned to the farm. AttrArn() *string // The farm ID. AttrFarmId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of the farm that helps identify what the farm is used for. Description() *string SetDescription(val *string) // The display name of the farm. DisplayName() *string SetDisplayName(val *string) // The ARN for the KMS key. KmsKeyArn() *string SetKmsKeyArn(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a farm to allow space for queues and fleets.
Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large 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" cfnFarm := awscdk.Aws_deadline.NewCfnFarm(this, jsii.String("MyCfnFarm"), &CfnFarmProps{ DisplayName: jsii.String("displayName"), // the properties below are optional Description: jsii.String("description"), KmsKeyArn: jsii.String("kmsKeyArn"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html
func NewCfnFarm ¶
func NewCfnFarm(scope constructs.Construct, id *string, props *CfnFarmProps) CfnFarm
type CfnFarmProps ¶
type CfnFarmProps struct { // The display name of the farm. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-displayname // DisplayName *string `field:"required" json:"displayName" yaml:"displayName"` // A description of the farm that helps identify what the farm is used for. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-description // // Default: - "". // Description *string `field:"optional" json:"description" yaml:"description"` // The ARN for the KMS key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html#cfn-deadline-farm-kmskeyarn // KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"` }
Properties for defining a `CfnFarm`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFarmProps := &CfnFarmProps{ DisplayName: jsii.String("displayName"), // the properties below are optional Description: jsii.String("description"), KmsKeyArn: jsii.String("kmsKeyArn"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-farm.html
type CfnFleet ¶
type CfnFleet interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) assigned to the fleet. AttrArn() *string AttrCapabilities() awscdk.IResolvable // The fleet ID. AttrFleetId() *string // The status of the fleet. AttrStatus() *string // The number of workers in the fleet summary. AttrWorkerCount() *float64 // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The configuration details for the fleet. Configuration() interface{} SetConfiguration(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description that helps identify what the fleet is used for. Description() *string SetDescription(val *string) // The display name of the fleet summary to update. DisplayName() *string SetDisplayName(val *string) // The farm ID. FarmId() *string SetFarmId(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 maximum number of workers specified in the fleet. MaxWorkerCount() *float64 SetMaxWorkerCount(val *float64) // The minimum number of workers in the fleet. MinWorkerCount() *float64 SetMinWorkerCount(val *float64) // 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 IAM role that workers in the fleet use when processing jobs. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a fleet.
Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFleet := awscdk.Aws_deadline.NewCfnFleet(this, jsii.String("MyCfnFleet"), &CfnFleetProps{ Configuration: &FleetConfigurationProperty{ CustomerManaged: &CustomerManagedFleetConfigurationProperty{ Mode: jsii.String("mode"), WorkerCapabilities: &CustomerManagedWorkerCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AcceleratorCount: &AcceleratorCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTypes: []*string{ jsii.String("acceleratorTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, }, // the properties below are optional StorageProfileId: jsii.String("storageProfileId"), }, ServiceManagedEc2: &ServiceManagedEc2FleetConfigurationProperty{ InstanceCapabilities: &ServiceManagedEc2InstanceCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AllowedInstanceTypes: []*string{ jsii.String("allowedInstanceTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, ExcludedInstanceTypes: []*string{ jsii.String("excludedInstanceTypes"), }, RootEbsVolume: &Ec2EbsVolumeProperty{ Iops: jsii.Number(123), SizeGiB: jsii.Number(123), ThroughputMiB: jsii.Number(123), }, }, InstanceMarketOptions: &ServiceManagedEc2InstanceMarketOptionsProperty{ Type: jsii.String("type"), }, }, }, DisplayName: jsii.String("displayName"), MaxWorkerCount: jsii.Number(123), RoleArn: jsii.String("roleArn"), // the properties below are optional Description: jsii.String("description"), FarmId: jsii.String("farmId"), MinWorkerCount: jsii.Number(123), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html
func NewCfnFleet ¶
func NewCfnFleet(scope constructs.Construct, id *string, props *CfnFleetProps) CfnFleet
type CfnFleetProps ¶
type CfnFleetProps struct { // The configuration details for the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-configuration // Configuration interface{} `field:"required" json:"configuration" yaml:"configuration"` // The display name of the fleet summary to update. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-displayname // DisplayName *string `field:"required" json:"displayName" yaml:"displayName"` // The maximum number of workers specified in the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-maxworkercount // MaxWorkerCount *float64 `field:"required" json:"maxWorkerCount" yaml:"maxWorkerCount"` // The IAM role that workers in the fleet use when processing jobs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // A description that helps identify what the fleet is used for. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-description // // Default: - "". // Description *string `field:"optional" json:"description" yaml:"description"` // The farm ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-farmid // FarmId *string `field:"optional" json:"farmId" yaml:"farmId"` // The minimum number of workers in the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html#cfn-deadline-fleet-minworkercount // // Default: - 0. // MinWorkerCount *float64 `field:"optional" json:"minWorkerCount" yaml:"minWorkerCount"` }
Properties for defining a `CfnFleet`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFleetProps := &CfnFleetProps{ Configuration: &FleetConfigurationProperty{ CustomerManaged: &CustomerManagedFleetConfigurationProperty{ Mode: jsii.String("mode"), WorkerCapabilities: &CustomerManagedWorkerCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AcceleratorCount: &AcceleratorCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTypes: []*string{ jsii.String("acceleratorTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, }, // the properties below are optional StorageProfileId: jsii.String("storageProfileId"), }, ServiceManagedEc2: &ServiceManagedEc2FleetConfigurationProperty{ InstanceCapabilities: &ServiceManagedEc2InstanceCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AllowedInstanceTypes: []*string{ jsii.String("allowedInstanceTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, ExcludedInstanceTypes: []*string{ jsii.String("excludedInstanceTypes"), }, RootEbsVolume: &Ec2EbsVolumeProperty{ Iops: jsii.Number(123), SizeGiB: jsii.Number(123), ThroughputMiB: jsii.Number(123), }, }, InstanceMarketOptions: &ServiceManagedEc2InstanceMarketOptionsProperty{ Type: jsii.String("type"), }, }, }, DisplayName: jsii.String("displayName"), MaxWorkerCount: jsii.Number(123), RoleArn: jsii.String("roleArn"), // the properties below are optional Description: jsii.String("description"), FarmId: jsii.String("farmId"), MinWorkerCount: jsii.Number(123), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-fleet.html
type CfnFleet_AcceleratorCountRangeProperty ¶
type CfnFleet_AcceleratorCountRangeProperty struct { // The minimum GPU for the accelerator. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcountrange.html#cfn-deadline-fleet-acceleratorcountrange-min // Min *float64 `field:"required" json:"min" yaml:"min"` // The maximum GPU for the accelerator. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratorcountrange.html#cfn-deadline-fleet-acceleratorcountrange-max // Max *float64 `field:"optional" json:"max" yaml:"max"` }
The range for the GPU fleet acceleration.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" acceleratorCountRangeProperty := &AcceleratorCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }
type CfnFleet_AcceleratorTotalMemoryMiBRangeProperty ¶
type CfnFleet_AcceleratorTotalMemoryMiBRangeProperty struct { // The minimum amount of memory to use for the accelerator, measured in MiB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratortotalmemorymibrange.html#cfn-deadline-fleet-acceleratortotalmemorymibrange-min // Min *float64 `field:"required" json:"min" yaml:"min"` // The maximum amount of memory to use for the accelerator, measured in MiB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-acceleratortotalmemorymibrange.html#cfn-deadline-fleet-acceleratortotalmemorymibrange-max // Max *float64 `field:"optional" json:"max" yaml:"max"` }
The range for memory, in MiB, to use for the accelerator.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" acceleratorTotalMemoryMiBRangeProperty := &AcceleratorTotalMemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }
type CfnFleet_CustomerManagedFleetConfigurationProperty ¶
type CfnFleet_CustomerManagedFleetConfigurationProperty struct { // The AWS Auto Scaling mode for the customer managed fleet configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-mode // Mode *string `field:"required" json:"mode" yaml:"mode"` // The worker capabilities for a customer managed fleet configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-workercapabilities // WorkerCapabilities interface{} `field:"required" json:"workerCapabilities" yaml:"workerCapabilities"` // The storage profile ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedfleetconfiguration.html#cfn-deadline-fleet-customermanagedfleetconfiguration-storageprofileid // StorageProfileId *string `field:"optional" json:"storageProfileId" yaml:"storageProfileId"` }
The details of a customer managed fleet 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" customerManagedFleetConfigurationProperty := &CustomerManagedFleetConfigurationProperty{ Mode: jsii.String("mode"), WorkerCapabilities: &CustomerManagedWorkerCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AcceleratorCount: &AcceleratorCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTypes: []*string{ jsii.String("acceleratorTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, }, // the properties below are optional StorageProfileId: jsii.String("storageProfileId"), }
type CfnFleet_CustomerManagedWorkerCapabilitiesProperty ¶
type CfnFleet_CustomerManagedWorkerCapabilitiesProperty struct { // The CPU architecture type for the customer managed worker capabilities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-cpuarchitecturetype // CpuArchitectureType *string `field:"required" json:"cpuArchitectureType" yaml:"cpuArchitectureType"` // The memory (MiB). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-memorymib // MemoryMiB interface{} `field:"required" json:"memoryMiB" yaml:"memoryMiB"` // The operating system (OS) family. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-osfamily // OsFamily *string `field:"required" json:"osFamily" yaml:"osFamily"` // The vCPU count for the customer manged worker capabilities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-vcpucount // VCpuCount interface{} `field:"required" json:"vCpuCount" yaml:"vCpuCount"` // The range of the accelerator. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-acceleratorcount // AcceleratorCount interface{} `field:"optional" json:"acceleratorCount" yaml:"acceleratorCount"` // The total memory (MiB) for the customer managed worker capabilities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-acceleratortotalmemorymib // AcceleratorTotalMemoryMiB interface{} `field:"optional" json:"acceleratorTotalMemoryMiB" yaml:"acceleratorTotalMemoryMiB"` // The accelerator types for the customer managed worker capabilities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-acceleratortypes // AcceleratorTypes *[]*string `field:"optional" json:"acceleratorTypes" yaml:"acceleratorTypes"` // Custom requirement ranges for customer managed worker capabilities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-customamounts // CustomAmounts interface{} `field:"optional" json:"customAmounts" yaml:"customAmounts"` // Custom attributes for the customer manged worker capabilities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-customermanagedworkercapabilities.html#cfn-deadline-fleet-customermanagedworkercapabilities-customattributes // CustomAttributes interface{} `field:"optional" json:"customAttributes" yaml:"customAttributes"` }
The worker capabilities for a customer managed workflow.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customerManagedWorkerCapabilitiesProperty := &CustomerManagedWorkerCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AcceleratorCount: &AcceleratorCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTypes: []*string{ jsii.String("acceleratorTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, }
type CfnFleet_Ec2EbsVolumeProperty ¶
type CfnFleet_Ec2EbsVolumeProperty struct { // The IOPS per volume. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html#cfn-deadline-fleet-ec2ebsvolume-iops // // Default: - 3000. // Iops *float64 `field:"optional" json:"iops" yaml:"iops"` // The EBS volume size in GiB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html#cfn-deadline-fleet-ec2ebsvolume-sizegib // // Default: - 250. // SizeGiB *float64 `field:"optional" json:"sizeGiB" yaml:"sizeGiB"` // The throughput per volume in MiB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-ec2ebsvolume.html#cfn-deadline-fleet-ec2ebsvolume-throughputmib // // Default: - 125. // ThroughputMiB *float64 `field:"optional" json:"throughputMiB" yaml:"throughputMiB"` }
Specifies the EBS volume.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ec2EbsVolumeProperty := &Ec2EbsVolumeProperty{ Iops: jsii.Number(123), SizeGiB: jsii.Number(123), ThroughputMiB: jsii.Number(123), }
type CfnFleet_FleetAmountCapabilityProperty ¶
type CfnFleet_FleetAmountCapabilityProperty struct { // The minimum amount of fleet worker capability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html#cfn-deadline-fleet-fleetamountcapability-min // Min *float64 `field:"required" json:"min" yaml:"min"` // The name of the fleet capability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html#cfn-deadline-fleet-fleetamountcapability-name // Name *string `field:"required" json:"name" yaml:"name"` // The maximum amount of the fleet worker capability. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetamountcapability.html#cfn-deadline-fleet-fleetamountcapability-max // Max *float64 `field:"optional" json:"max" yaml:"max"` }
The fleet amount and attribute capabilities.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" fleetAmountCapabilityProperty := &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }
type CfnFleet_FleetAttributeCapabilityProperty ¶
type CfnFleet_FleetAttributeCapabilityProperty struct { // The name of the fleet attribute capability for the worker. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetattributecapability.html#cfn-deadline-fleet-fleetattributecapability-name // Name *string `field:"required" json:"name" yaml:"name"` // The number of fleet attribute capabilities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetattributecapability.html#cfn-deadline-fleet-fleetattributecapability-values // Values *[]*string `field:"required" json:"values" yaml:"values"` }
Defines the fleet's capability name, minimum, and maximum.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" fleetAttributeCapabilityProperty := &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }
type CfnFleet_FleetCapabilitiesProperty ¶
type CfnFleet_FleetCapabilitiesProperty struct { // Amount capabilities of the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetcapabilities.html#cfn-deadline-fleet-fleetcapabilities-amounts // Amounts interface{} `field:"optional" json:"amounts" yaml:"amounts"` // Attribute capabilities of the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetcapabilities.html#cfn-deadline-fleet-fleetcapabilities-attributes // Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"` }
The amounts and attributes of fleets.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" fleetCapabilitiesProperty := &FleetCapabilitiesProperty{ Amounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, Attributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, }
type CfnFleet_FleetConfigurationProperty ¶
type CfnFleet_FleetConfigurationProperty struct { // The customer managed fleets within a fleet configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetconfiguration.html#cfn-deadline-fleet-fleetconfiguration-customermanaged // CustomerManaged interface{} `field:"optional" json:"customerManaged" yaml:"customerManaged"` // The service managed Amazon EC2 instances for a fleet configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-fleetconfiguration.html#cfn-deadline-fleet-fleetconfiguration-servicemanagedec2 // ServiceManagedEc2 interface{} `field:"optional" json:"serviceManagedEc2" yaml:"serviceManagedEc2"` }
Fleet configuration details.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" fleetConfigurationProperty := &FleetConfigurationProperty{ CustomerManaged: &CustomerManagedFleetConfigurationProperty{ Mode: jsii.String("mode"), WorkerCapabilities: &CustomerManagedWorkerCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AcceleratorCount: &AcceleratorCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTotalMemoryMiB: &AcceleratorTotalMemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, AcceleratorTypes: []*string{ jsii.String("acceleratorTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, }, // the properties below are optional StorageProfileId: jsii.String("storageProfileId"), }, ServiceManagedEc2: &ServiceManagedEc2FleetConfigurationProperty{ InstanceCapabilities: &ServiceManagedEc2InstanceCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AllowedInstanceTypes: []*string{ jsii.String("allowedInstanceTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, ExcludedInstanceTypes: []*string{ jsii.String("excludedInstanceTypes"), }, RootEbsVolume: &Ec2EbsVolumeProperty{ Iops: jsii.Number(123), SizeGiB: jsii.Number(123), ThroughputMiB: jsii.Number(123), }, }, InstanceMarketOptions: &ServiceManagedEc2InstanceMarketOptionsProperty{ Type: jsii.String("type"), }, }, }
type CfnFleet_MemoryMiBRangeProperty ¶
type CfnFleet_MemoryMiBRangeProperty struct { // The minimum amount of memory (in MiB). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-memorymibrange.html#cfn-deadline-fleet-memorymibrange-min // Min *float64 `field:"required" json:"min" yaml:"min"` // The maximum amount of memory (in MiB). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-memorymibrange.html#cfn-deadline-fleet-memorymibrange-max // Max *float64 `field:"optional" json:"max" yaml:"max"` }
The range of memory in MiB.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" memoryMiBRangeProperty := &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }
type CfnFleet_ServiceManagedEc2FleetConfigurationProperty ¶
type CfnFleet_ServiceManagedEc2FleetConfigurationProperty struct { // The Amazon EC2 instance capabilities. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html#cfn-deadline-fleet-servicemanagedec2fleetconfiguration-instancecapabilities // InstanceCapabilities interface{} `field:"required" json:"instanceCapabilities" yaml:"instanceCapabilities"` // The Amazon EC2 market type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2fleetconfiguration.html#cfn-deadline-fleet-servicemanagedec2fleetconfiguration-instancemarketoptions // InstanceMarketOptions interface{} `field:"required" json:"instanceMarketOptions" yaml:"instanceMarketOptions"` }
The configuration details for a service managed Amazon EC2 fleet.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" serviceManagedEc2FleetConfigurationProperty := &ServiceManagedEc2FleetConfigurationProperty{ InstanceCapabilities: &ServiceManagedEc2InstanceCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AllowedInstanceTypes: []*string{ jsii.String("allowedInstanceTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, ExcludedInstanceTypes: []*string{ jsii.String("excludedInstanceTypes"), }, RootEbsVolume: &Ec2EbsVolumeProperty{ Iops: jsii.Number(123), SizeGiB: jsii.Number(123), ThroughputMiB: jsii.Number(123), }, }, InstanceMarketOptions: &ServiceManagedEc2InstanceMarketOptionsProperty{ Type: jsii.String("type"), }, }
type CfnFleet_ServiceManagedEc2InstanceCapabilitiesProperty ¶
type CfnFleet_ServiceManagedEc2InstanceCapabilitiesProperty struct { // The CPU architecture type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-cpuarchitecturetype // CpuArchitectureType *string `field:"required" json:"cpuArchitectureType" yaml:"cpuArchitectureType"` // The memory, as MiB, for the Amazon EC2 instance type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-memorymib // MemoryMiB interface{} `field:"required" json:"memoryMiB" yaml:"memoryMiB"` // The operating system (OS) family. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-osfamily // OsFamily *string `field:"required" json:"osFamily" yaml:"osFamily"` // The amount of vCPU to require for instances in this fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-vcpucount // VCpuCount interface{} `field:"required" json:"vCpuCount" yaml:"vCpuCount"` // The allowable Amazon EC2 instance types. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-allowedinstancetypes // AllowedInstanceTypes *[]*string `field:"optional" json:"allowedInstanceTypes" yaml:"allowedInstanceTypes"` // The custom capability amounts to require for instances in this fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-customamounts // CustomAmounts interface{} `field:"optional" json:"customAmounts" yaml:"customAmounts"` // The custom capability attributes to require for instances in this fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-customattributes // CustomAttributes interface{} `field:"optional" json:"customAttributes" yaml:"customAttributes"` // The instance types to exclude from the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-excludedinstancetypes // ExcludedInstanceTypes *[]*string `field:"optional" json:"excludedInstanceTypes" yaml:"excludedInstanceTypes"` // The root EBS volume. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancecapabilities.html#cfn-deadline-fleet-servicemanagedec2instancecapabilities-rootebsvolume // RootEbsVolume interface{} `field:"optional" json:"rootEbsVolume" yaml:"rootEbsVolume"` }
The Amazon EC2 instance capabilities.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" serviceManagedEc2InstanceCapabilitiesProperty := &ServiceManagedEc2InstanceCapabilitiesProperty{ CpuArchitectureType: jsii.String("cpuArchitectureType"), MemoryMiB: &MemoryMiBRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, OsFamily: jsii.String("osFamily"), VCpuCount: &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }, // the properties below are optional AllowedInstanceTypes: []*string{ jsii.String("allowedInstanceTypes"), }, CustomAmounts: []interface{}{ &FleetAmountCapabilityProperty{ Min: jsii.Number(123), Name: jsii.String("name"), // the properties below are optional Max: jsii.Number(123), }, }, CustomAttributes: []interface{}{ &FleetAttributeCapabilityProperty{ Name: jsii.String("name"), Values: []*string{ jsii.String("values"), }, }, }, ExcludedInstanceTypes: []*string{ jsii.String("excludedInstanceTypes"), }, RootEbsVolume: &Ec2EbsVolumeProperty{ Iops: jsii.Number(123), SizeGiB: jsii.Number(123), ThroughputMiB: jsii.Number(123), }, }
type CfnFleet_ServiceManagedEc2InstanceMarketOptionsProperty ¶
type CfnFleet_ServiceManagedEc2InstanceMarketOptionsProperty struct { // The Amazon EC2 instance type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-servicemanagedec2instancemarketoptions.html#cfn-deadline-fleet-servicemanagedec2instancemarketoptions-type // Type *string `field:"required" json:"type" yaml:"type"` }
The details of the Amazon EC2 instance market options for a service managed fleet.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" serviceManagedEc2InstanceMarketOptionsProperty := &ServiceManagedEc2InstanceMarketOptionsProperty{ Type: jsii.String("type"), }
type CfnFleet_VCpuCountRangeProperty ¶
type CfnFleet_VCpuCountRangeProperty struct { // The minimum amount of vCPU. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vcpucountrange.html#cfn-deadline-fleet-vcpucountrange-min // Min *float64 `field:"required" json:"min" yaml:"min"` // The maximum amount of vCPU. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-vcpucountrange.html#cfn-deadline-fleet-vcpucountrange-max // Max *float64 `field:"optional" json:"max" yaml:"max"` }
The allowable range of vCPU processing power for the fleet.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" vCpuCountRangeProperty := &VCpuCountRangeProperty{ Min: jsii.Number(123), // the properties below are optional Max: jsii.Number(123), }
type CfnLicenseEndpoint ¶
type CfnLicenseEndpoint interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) of the license endpoint. AttrArn() *string // The DNS name of the license server endpoint. AttrDnsName() *string // The license endpoint ID. AttrLicenseEndpointId() *string // The status of the license endpoint. AttrStatus() *string // The status message of the license endpoint. AttrStatusMessage() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The identifier of the Amazon EC2 security group that controls access to the license endpoint. SecurityGroupIds() *[]*string SetSecurityGroupIds(val *[]*string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Identifies the VPC subnets that can connect to a license endpoint. SubnetIds() *[]*string SetSubnetIds(val *[]*string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The VCP(virtual private cloud) ID associated with the license endpoint. VpcId() *string SetVpcId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLicenseEndpoint := awscdk.Aws_deadline.NewCfnLicenseEndpoint(this, jsii.String("MyCfnLicenseEndpoint"), &CfnLicenseEndpointProps{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, VpcId: jsii.String("vpcId"), })
func NewCfnLicenseEndpoint ¶
func NewCfnLicenseEndpoint(scope constructs.Construct, id *string, props *CfnLicenseEndpointProps) CfnLicenseEndpoint
type CfnLicenseEndpointProps ¶
type CfnLicenseEndpointProps struct { // The identifier of the Amazon EC2 security group that controls access to the license endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#cfn-deadline-licenseendpoint-securitygroupids // SecurityGroupIds *[]*string `field:"required" json:"securityGroupIds" yaml:"securityGroupIds"` // Identifies the VPC subnets that can connect to a license endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#cfn-deadline-licenseendpoint-subnetids // SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"` // The VCP(virtual private cloud) ID associated with the license endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-licenseendpoint.html#cfn-deadline-licenseendpoint-vpcid // VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"` }
Properties for defining a `CfnLicenseEndpoint`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLicenseEndpointProps := &CfnLicenseEndpointProps{ SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, VpcId: jsii.String("vpcId"), }
type CfnMeteredProduct ¶
type CfnMeteredProduct interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) of the metered product. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The family to which the metered product belongs. Family() *string SetFamily(val *string) // The Amazon EC2 identifier of the license endpoint. LicenseEndpointId() *string SetLicenseEndpointId(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 port on which the metered product should run. Port() *float64 SetPort(val *float64) // The product ID. ProductId() *string SetProductId(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 vendor. Vendor() *string SetVendor(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Adds a metered product.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMeteredProduct := awscdk.Aws_deadline.NewCfnMeteredProduct(this, jsii.String("MyCfnMeteredProduct"), &CfnMeteredProductProps{ Family: jsii.String("family"), LicenseEndpointId: jsii.String("licenseEndpointId"), Port: jsii.Number(123), ProductId: jsii.String("productId"), Vendor: jsii.String("vendor"), })
func NewCfnMeteredProduct ¶
func NewCfnMeteredProduct(scope constructs.Construct, id *string, props *CfnMeteredProductProps) CfnMeteredProduct
type CfnMeteredProductProps ¶
type CfnMeteredProductProps struct { // The family to which the metered product belongs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#cfn-deadline-meteredproduct-family // Family *string `field:"optional" json:"family" yaml:"family"` // The Amazon EC2 identifier of the license endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#cfn-deadline-meteredproduct-licenseendpointid // LicenseEndpointId *string `field:"optional" json:"licenseEndpointId" yaml:"licenseEndpointId"` // The port on which the metered product should run. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#cfn-deadline-meteredproduct-port // Port *float64 `field:"optional" json:"port" yaml:"port"` // The product ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#cfn-deadline-meteredproduct-productid // ProductId *string `field:"optional" json:"productId" yaml:"productId"` // The vendor. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-meteredproduct.html#cfn-deadline-meteredproduct-vendor // Vendor *string `field:"optional" json:"vendor" yaml:"vendor"` }
Properties for defining a `CfnMeteredProduct`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMeteredProductProps := &CfnMeteredProductProps{ Family: jsii.String("family"), LicenseEndpointId: jsii.String("licenseEndpointId"), Port: jsii.Number(123), ProductId: jsii.String("productId"), Vendor: jsii.String("vendor"), }
type CfnQueue ¶
type CfnQueue interface { awscdk.CfnResource awscdk.IInspectable // The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems. AllowedStorageProfileIds() *[]*string SetAllowedStorageProfileIds(val *[]*string) // The Amazon Resource Name (ARN) of the queue. AttrArn() *string // The queue ID. AttrQueueId() *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 default action taken on a queue summary if a budget wasn't configured. DefaultBudgetAction() *string SetDefaultBudgetAction(val *string) // A description of the queue that helps identify what the queue is used for. Description() *string SetDescription(val *string) // The display name of the queue summary to update. DisplayName() *string SetDisplayName(val *string) // The farm ID. FarmId() *string SetFarmId(val *string) // The job attachment settings. JobAttachmentSettings() interface{} SetJobAttachmentSettings(val interface{}) // Identifies the user for a job. JobRunAsUser() interface{} SetJobRunAsUser(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The file system location that the queue uses. RequiredFileSystemLocationNames() *[]*string SetRequiredFileSystemLocationNames(val *[]*string) // The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue. RoleArn() *string SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a queue to coordinate the order in which jobs run on a farm.
A queue can also specify where to pull resources and indicate where to output completed jobs.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnQueue := awscdk.Aws_deadline.NewCfnQueue(this, jsii.String("MyCfnQueue"), &CfnQueueProps{ DisplayName: jsii.String("displayName"), // the properties below are optional AllowedStorageProfileIds: []*string{ jsii.String("allowedStorageProfileIds"), }, DefaultBudgetAction: jsii.String("defaultBudgetAction"), Description: jsii.String("description"), FarmId: jsii.String("farmId"), JobAttachmentSettings: &JobAttachmentSettingsProperty{ RootPrefix: jsii.String("rootPrefix"), S3BucketName: jsii.String("s3BucketName"), }, JobRunAsUser: &JobRunAsUserProperty{ RunAs: jsii.String("runAs"), // the properties below are optional Posix: &PosixUserProperty{ Group: jsii.String("group"), User: jsii.String("user"), }, Windows: &WindowsUserProperty{ PasswordArn: jsii.String("passwordArn"), User: jsii.String("user"), }, }, RequiredFileSystemLocationNames: []*string{ jsii.String("requiredFileSystemLocationNames"), }, RoleArn: jsii.String("roleArn"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html
func NewCfnQueue ¶
func NewCfnQueue(scope constructs.Construct, id *string, props *CfnQueueProps) CfnQueue
type CfnQueueEnvironment ¶
type CfnQueueEnvironment interface { awscdk.CfnResource awscdk.IInspectable // The name of the queue environment. AttrName() *string // The queue environment ID. AttrQueueEnvironmentId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The identifier assigned to the farm that contains the queue. FarmId() *string SetFarmId(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 queue environment's priority. Priority() *float64 SetPriority(val *float64) // The unique identifier of the queue that contains the environment. QueueId() *string SetQueueId(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 // A JSON or YAML template the describes the processing environment for the queue. Template() *string SetTemplate(val *string) // Specifies whether the template for the queue environment is JSON or YAML. TemplateType() *string SetTemplateType(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{}) }
Creates an environment for a queue that defines how jobs in the queue run.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnQueueEnvironment := awscdk.Aws_deadline.NewCfnQueueEnvironment(this, jsii.String("MyCfnQueueEnvironment"), &CfnQueueEnvironmentProps{ FarmId: jsii.String("farmId"), Priority: jsii.Number(123), QueueId: jsii.String("queueId"), Template: jsii.String("template"), TemplateType: jsii.String("templateType"), })
func NewCfnQueueEnvironment ¶
func NewCfnQueueEnvironment(scope constructs.Construct, id *string, props *CfnQueueEnvironmentProps) CfnQueueEnvironment
type CfnQueueEnvironmentProps ¶
type CfnQueueEnvironmentProps struct { // The identifier assigned to the farm that contains the queue. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-farmid // FarmId *string `field:"required" json:"farmId" yaml:"farmId"` // The queue environment's priority. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-priority // Priority *float64 `field:"required" json:"priority" yaml:"priority"` // The unique identifier of the queue that contains the environment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-queueid // QueueId *string `field:"required" json:"queueId" yaml:"queueId"` // A JSON or YAML template the describes the processing environment for the queue. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-template // Template *string `field:"required" json:"template" yaml:"template"` // Specifies whether the template for the queue environment is JSON or YAML. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queueenvironment.html#cfn-deadline-queueenvironment-templatetype // TemplateType *string `field:"required" json:"templateType" yaml:"templateType"` }
Properties for defining a `CfnQueueEnvironment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnQueueEnvironmentProps := &CfnQueueEnvironmentProps{ FarmId: jsii.String("farmId"), Priority: jsii.Number(123), QueueId: jsii.String("queueId"), Template: jsii.String("template"), TemplateType: jsii.String("templateType"), }
type CfnQueueFleetAssociation ¶
type CfnQueueFleetAssociation interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The identifier of the farm that contains the queue and the fleet. FarmId() *string SetFarmId(val *string) // The fleet ID. FleetId() *string SetFleetId(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 queue ID. QueueId() *string SetQueueId(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates an association between a queue and a fleet.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnQueueFleetAssociation := awscdk.Aws_deadline.NewCfnQueueFleetAssociation(this, jsii.String("MyCfnQueueFleetAssociation"), &CfnQueueFleetAssociationProps{ FarmId: jsii.String("farmId"), FleetId: jsii.String("fleetId"), QueueId: jsii.String("queueId"), })
func NewCfnQueueFleetAssociation ¶
func NewCfnQueueFleetAssociation(scope constructs.Construct, id *string, props *CfnQueueFleetAssociationProps) CfnQueueFleetAssociation
type CfnQueueFleetAssociationProps ¶
type CfnQueueFleetAssociationProps struct { // The identifier of the farm that contains the queue and the fleet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuefleetassociation.html#cfn-deadline-queuefleetassociation-farmid // FarmId *string `field:"required" json:"farmId" yaml:"farmId"` // The fleet ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuefleetassociation.html#cfn-deadline-queuefleetassociation-fleetid // FleetId *string `field:"required" json:"fleetId" yaml:"fleetId"` // The queue ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queuefleetassociation.html#cfn-deadline-queuefleetassociation-queueid // QueueId *string `field:"required" json:"queueId" yaml:"queueId"` }
Properties for defining a `CfnQueueFleetAssociation`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnQueueFleetAssociationProps := &CfnQueueFleetAssociationProps{ FarmId: jsii.String("farmId"), FleetId: jsii.String("fleetId"), QueueId: jsii.String("queueId"), }
type CfnQueueProps ¶
type CfnQueueProps struct { // The display name of the queue summary to update. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-displayname // DisplayName *string `field:"required" json:"displayName" yaml:"displayName"` // The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-allowedstorageprofileids // AllowedStorageProfileIds *[]*string `field:"optional" json:"allowedStorageProfileIds" yaml:"allowedStorageProfileIds"` // The default action taken on a queue summary if a budget wasn't configured. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-defaultbudgetaction // // Default: - "NONE". // DefaultBudgetAction *string `field:"optional" json:"defaultBudgetAction" yaml:"defaultBudgetAction"` // A description of the queue that helps identify what the queue is used for. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-description // // Default: - "". // Description *string `field:"optional" json:"description" yaml:"description"` // The farm ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-farmid // FarmId *string `field:"optional" json:"farmId" yaml:"farmId"` // The job attachment settings. // // These are the Amazon S3 bucket name and the Amazon S3 prefix. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-jobattachmentsettings // JobAttachmentSettings interface{} `field:"optional" json:"jobAttachmentSettings" yaml:"jobAttachmentSettings"` // Identifies the user for a job. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-jobrunasuser // JobRunAsUser interface{} `field:"optional" json:"jobRunAsUser" yaml:"jobRunAsUser"` // The file system location that the queue uses. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-requiredfilesystemlocationnames // RequiredFileSystemLocationNames *[]*string `field:"optional" json:"requiredFileSystemLocationNames" yaml:"requiredFileSystemLocationNames"` // The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html#cfn-deadline-queue-rolearn // RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` }
Properties for defining a `CfnQueue`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnQueueProps := &CfnQueueProps{ DisplayName: jsii.String("displayName"), // the properties below are optional AllowedStorageProfileIds: []*string{ jsii.String("allowedStorageProfileIds"), }, DefaultBudgetAction: jsii.String("defaultBudgetAction"), Description: jsii.String("description"), FarmId: jsii.String("farmId"), JobAttachmentSettings: &JobAttachmentSettingsProperty{ RootPrefix: jsii.String("rootPrefix"), S3BucketName: jsii.String("s3BucketName"), }, JobRunAsUser: &JobRunAsUserProperty{ RunAs: jsii.String("runAs"), // the properties below are optional Posix: &PosixUserProperty{ Group: jsii.String("group"), User: jsii.String("user"), }, Windows: &WindowsUserProperty{ PasswordArn: jsii.String("passwordArn"), User: jsii.String("user"), }, }, RequiredFileSystemLocationNames: []*string{ jsii.String("requiredFileSystemLocationNames"), }, RoleArn: jsii.String("roleArn"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-queue.html
type CfnQueue_JobAttachmentSettingsProperty ¶
type CfnQueue_JobAttachmentSettingsProperty struct { // The root prefix. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobattachmentsettings.html#cfn-deadline-queue-jobattachmentsettings-rootprefix // RootPrefix *string `field:"required" json:"rootPrefix" yaml:"rootPrefix"` // The Amazon S3 bucket name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobattachmentsettings.html#cfn-deadline-queue-jobattachmentsettings-s3bucketname // S3BucketName *string `field:"required" json:"s3BucketName" yaml:"s3BucketName"` }
The job attachment settings.
These are the Amazon S3 bucket name and the Amazon S3 prefix.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jobAttachmentSettingsProperty := &JobAttachmentSettingsProperty{ RootPrefix: jsii.String("rootPrefix"), S3BucketName: jsii.String("s3BucketName"), }
type CfnQueue_JobRunAsUserProperty ¶
type CfnQueue_JobRunAsUserProperty struct { // Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobrunasuser.html#cfn-deadline-queue-jobrunasuser-runas // RunAs *string `field:"required" json:"runAs" yaml:"runAs"` // The user and group that the jobs in the queue run as. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobrunasuser.html#cfn-deadline-queue-jobrunasuser-posix // Posix interface{} `field:"optional" json:"posix" yaml:"posix"` // Identifies a Microsoft Windows user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-jobrunasuser.html#cfn-deadline-queue-jobrunasuser-windows // Windows interface{} `field:"optional" json:"windows" yaml:"windows"` }
Identifies the user for a job.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" jobRunAsUserProperty := &JobRunAsUserProperty{ RunAs: jsii.String("runAs"), // the properties below are optional Posix: &PosixUserProperty{ Group: jsii.String("group"), User: jsii.String("user"), }, Windows: &WindowsUserProperty{ PasswordArn: jsii.String("passwordArn"), User: jsii.String("user"), }, }
type CfnQueue_PosixUserProperty ¶
type CfnQueue_PosixUserProperty struct { // The name of the POSIX user's group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-posixuser.html#cfn-deadline-queue-posixuser-group // Group *string `field:"required" json:"group" yaml:"group"` // The name of the POSIX user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-posixuser.html#cfn-deadline-queue-posixuser-user // User *string `field:"required" json:"user" yaml:"user"` }
The POSIX user.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" posixUserProperty := &PosixUserProperty{ Group: jsii.String("group"), User: jsii.String("user"), }
type CfnQueue_WindowsUserProperty ¶
type CfnQueue_WindowsUserProperty struct { // The password ARN for the Windows user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-windowsuser.html#cfn-deadline-queue-windowsuser-passwordarn // PasswordArn *string `field:"required" json:"passwordArn" yaml:"passwordArn"` // The user. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-queue-windowsuser.html#cfn-deadline-queue-windowsuser-user // User *string `field:"required" json:"user" yaml:"user"` }
The Windows user details.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" windowsUserProperty := &WindowsUserProperty{ PasswordArn: jsii.String("passwordArn"), User: jsii.String("user"), }
type CfnStorageProfile ¶
type CfnStorageProfile interface { awscdk.CfnResource awscdk.IInspectable // The storage profile ID. AttrStorageProfileId() *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 display name of the storage profile summary to update. DisplayName() *string SetDisplayName(val *string) // The unique identifier of the farm that contains the storage profile. FarmId() *string SetFarmId(val *string) // Operating system specific file system path to the storage location. FileSystemLocations() interface{} SetFileSystemLocations(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The operating system (OS) family. OsFamily() *string SetOsFamily(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnStorageProfile := awscdk.Aws_deadline.NewCfnStorageProfile(this, jsii.String("MyCfnStorageProfile"), &CfnStorageProfileProps{ DisplayName: jsii.String("displayName"), OsFamily: jsii.String("osFamily"), // the properties below are optional FarmId: jsii.String("farmId"), FileSystemLocations: []interface{}{ &FileSystemLocationProperty{ Name: jsii.String("name"), Path: jsii.String("path"), Type: jsii.String("type"), }, }, })
func NewCfnStorageProfile ¶
func NewCfnStorageProfile(scope constructs.Construct, id *string, props *CfnStorageProfileProps) CfnStorageProfile
type CfnStorageProfileProps ¶
type CfnStorageProfileProps struct { // The display name of the storage profile summary to update. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html#cfn-deadline-storageprofile-displayname // DisplayName *string `field:"required" json:"displayName" yaml:"displayName"` // The operating system (OS) family. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html#cfn-deadline-storageprofile-osfamily // OsFamily *string `field:"required" json:"osFamily" yaml:"osFamily"` // The unique identifier of the farm that contains the storage profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html#cfn-deadline-storageprofile-farmid // FarmId *string `field:"optional" json:"farmId" yaml:"farmId"` // Operating system specific file system path to the storage location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-deadline-storageprofile.html#cfn-deadline-storageprofile-filesystemlocations // FileSystemLocations interface{} `field:"optional" json:"fileSystemLocations" yaml:"fileSystemLocations"` }
Properties for defining a `CfnStorageProfile`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnStorageProfileProps := &CfnStorageProfileProps{ DisplayName: jsii.String("displayName"), OsFamily: jsii.String("osFamily"), // the properties below are optional FarmId: jsii.String("farmId"), FileSystemLocations: []interface{}{ &FileSystemLocationProperty{ Name: jsii.String("name"), Path: jsii.String("path"), Type: jsii.String("type"), }, }, }
type CfnStorageProfile_FileSystemLocationProperty ¶
type CfnStorageProfile_FileSystemLocationProperty struct { // The location name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-storageprofile-filesystemlocation.html#cfn-deadline-storageprofile-filesystemlocation-name // Name *string `field:"required" json:"name" yaml:"name"` // The file path. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-storageprofile-filesystemlocation.html#cfn-deadline-storageprofile-filesystemlocation-path // Path *string `field:"required" json:"path" yaml:"path"` // The type of file. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-storageprofile-filesystemlocation.html#cfn-deadline-storageprofile-filesystemlocation-type // Type *string `field:"required" json:"type" yaml:"type"` }
The details of the file system location for the resource.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" fileSystemLocationProperty := &FileSystemLocationProperty{ Name: jsii.String("name"), Path: jsii.String("path"), Type: jsii.String("type"), }
Source Files ¶
- CfnFarm.go
- CfnFarmProps.go
- CfnFarm__checks.go
- CfnFleet.go
- CfnFleetProps.go
- CfnFleet_AcceleratorCountRangeProperty.go
- CfnFleet_AcceleratorTotalMemoryMiBRangeProperty.go
- CfnFleet_CustomerManagedFleetConfigurationProperty.go
- CfnFleet_CustomerManagedWorkerCapabilitiesProperty.go
- CfnFleet_Ec2EbsVolumeProperty.go
- CfnFleet_FleetAmountCapabilityProperty.go
- CfnFleet_FleetAttributeCapabilityProperty.go
- CfnFleet_FleetCapabilitiesProperty.go
- CfnFleet_FleetConfigurationProperty.go
- CfnFleet_MemoryMiBRangeProperty.go
- CfnFleet_ServiceManagedEc2FleetConfigurationProperty.go
- CfnFleet_ServiceManagedEc2InstanceCapabilitiesProperty.go
- CfnFleet_ServiceManagedEc2InstanceMarketOptionsProperty.go
- CfnFleet_VCpuCountRangeProperty.go
- CfnFleet__checks.go
- CfnLicenseEndpoint.go
- CfnLicenseEndpointProps.go
- CfnLicenseEndpoint__checks.go
- CfnMeteredProduct.go
- CfnMeteredProductProps.go
- CfnMeteredProduct__checks.go
- CfnQueue.go
- CfnQueueEnvironment.go
- CfnQueueEnvironmentProps.go
- CfnQueueEnvironment__checks.go
- CfnQueueFleetAssociation.go
- CfnQueueFleetAssociationProps.go
- CfnQueueFleetAssociation__checks.go
- CfnQueueProps.go
- CfnQueue_JobAttachmentSettingsProperty.go
- CfnQueue_JobRunAsUserProperty.go
- CfnQueue_PosixUserProperty.go
- CfnQueue_WindowsUserProperty.go
- CfnQueue__checks.go
- CfnStorageProfile.go
- CfnStorageProfileProps.go
- CfnStorageProfile_FileSystemLocationProperty.go
- CfnStorageProfile__checks.go
- main.go