Documentation ¶
Index ¶
- func CfnApp_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApp_IsCfnElement(x interface{}) *bool
- func CfnApp_IsCfnResource(x interface{}) *bool
- func CfnApp_IsConstruct(x interface{}) *bool
- func CfnElasticLoadBalancerAttachment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnElasticLoadBalancerAttachment_IsCfnElement(x interface{}) *bool
- func CfnElasticLoadBalancerAttachment_IsCfnResource(x interface{}) *bool
- func CfnElasticLoadBalancerAttachment_IsConstruct(x interface{}) *bool
- func CfnInstance_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInstance_IsCfnElement(x interface{}) *bool
- func CfnInstance_IsCfnResource(x interface{}) *bool
- func CfnInstance_IsConstruct(x interface{}) *bool
- func CfnLayer_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLayer_IsCfnElement(x interface{}) *bool
- func CfnLayer_IsCfnResource(x interface{}) *bool
- func CfnLayer_IsConstruct(x interface{}) *bool
- func CfnStack_CFN_RESOURCE_TYPE_NAME() *string
- func CfnStack_IsCfnElement(x interface{}) *bool
- func CfnStack_IsCfnResource(x interface{}) *bool
- func CfnStack_IsConstruct(x interface{}) *bool
- func CfnUserProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUserProfile_IsCfnElement(x interface{}) *bool
- func CfnUserProfile_IsCfnResource(x interface{}) *bool
- func CfnUserProfile_IsConstruct(x interface{}) *bool
- func CfnVolume_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVolume_IsCfnElement(x interface{}) *bool
- func CfnVolume_IsCfnResource(x interface{}) *bool
- func CfnVolume_IsConstruct(x interface{}) *bool
- func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)
- func NewCfnElasticLoadBalancerAttachment_Override(c CfnElasticLoadBalancerAttachment, scope constructs.Construct, id *string, ...)
- func NewCfnInstance_Override(c CfnInstance, scope constructs.Construct, id *string, props *CfnInstanceProps)
- func NewCfnLayer_Override(c CfnLayer, scope constructs.Construct, id *string, props *CfnLayerProps)
- func NewCfnStack_Override(c CfnStack, scope constructs.Construct, id *string, props *CfnStackProps)
- func NewCfnUserProfile_Override(c CfnUserProfile, scope constructs.Construct, id *string, ...)
- func NewCfnVolume_Override(c CfnVolume, scope constructs.Construct, id *string, props *CfnVolumeProps)
- type CfnApp
- type CfnAppProps
- type CfnApp_DataSourceProperty
- type CfnApp_EnvironmentVariableProperty
- type CfnApp_SourceProperty
- type CfnApp_SslConfigurationProperty
- type CfnElasticLoadBalancerAttachment
- type CfnElasticLoadBalancerAttachmentProps
- type CfnInstance
- type CfnInstanceProps
- type CfnInstance_BlockDeviceMappingProperty
- type CfnInstance_EbsBlockDeviceProperty
- type CfnInstance_TimeBasedAutoScalingProperty
- type CfnLayer
- type CfnLayerProps
- type CfnLayer_AutoScalingThresholdsProperty
- type CfnLayer_LifecycleEventConfigurationProperty
- type CfnLayer_LoadBasedAutoScalingProperty
- type CfnLayer_RecipesProperty
- type CfnLayer_ShutdownEventConfigurationProperty
- type CfnLayer_VolumeConfigurationProperty
- type CfnStack
- type CfnStackProps
- type CfnStack_ChefConfigurationProperty
- type CfnStack_ElasticIpProperty
- type CfnStack_RdsDbInstanceProperty
- type CfnStack_SourceProperty
- type CfnStack_StackConfigurationManagerProperty
- type CfnUserProfile
- type CfnUserProfileProps
- type CfnVolume
- type CfnVolumeProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnApp_CFN_RESOURCE_TYPE_NAME ¶
func CfnApp_CFN_RESOURCE_TYPE_NAME() *string
func CfnApp_IsCfnElement ¶
func CfnApp_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 CfnApp_IsCfnResource ¶
func CfnApp_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnApp_IsConstruct ¶
func CfnApp_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 CfnElasticLoadBalancerAttachment_CFN_RESOURCE_TYPE_NAME ¶
func CfnElasticLoadBalancerAttachment_CFN_RESOURCE_TYPE_NAME() *string
func CfnElasticLoadBalancerAttachment_IsCfnElement ¶
func CfnElasticLoadBalancerAttachment_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 CfnElasticLoadBalancerAttachment_IsCfnResource ¶
func CfnElasticLoadBalancerAttachment_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnElasticLoadBalancerAttachment_IsConstruct ¶
func CfnElasticLoadBalancerAttachment_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 CfnInstance_CFN_RESOURCE_TYPE_NAME ¶
func CfnInstance_CFN_RESOURCE_TYPE_NAME() *string
func CfnInstance_IsCfnElement ¶
func CfnInstance_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 CfnInstance_IsCfnResource ¶
func CfnInstance_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInstance_IsConstruct ¶
func CfnInstance_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 CfnLayer_CFN_RESOURCE_TYPE_NAME ¶
func CfnLayer_CFN_RESOURCE_TYPE_NAME() *string
func CfnLayer_IsCfnElement ¶
func CfnLayer_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 CfnLayer_IsCfnResource ¶
func CfnLayer_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLayer_IsConstruct ¶
func CfnLayer_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 CfnStack_CFN_RESOURCE_TYPE_NAME ¶
func CfnStack_CFN_RESOURCE_TYPE_NAME() *string
func CfnStack_IsCfnElement ¶
func CfnStack_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 CfnStack_IsCfnResource ¶
func CfnStack_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnStack_IsConstruct ¶
func CfnStack_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 CfnUserProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnUserProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnUserProfile_IsCfnElement ¶
func CfnUserProfile_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 CfnUserProfile_IsCfnResource ¶
func CfnUserProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnUserProfile_IsConstruct ¶
func CfnUserProfile_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 CfnVolume_CFN_RESOURCE_TYPE_NAME ¶
func CfnVolume_CFN_RESOURCE_TYPE_NAME() *string
func CfnVolume_IsCfnElement ¶
func CfnVolume_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 CfnVolume_IsCfnResource ¶
func CfnVolume_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVolume_IsConstruct ¶
func CfnVolume_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 NewCfnApp_Override ¶
func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)
func NewCfnElasticLoadBalancerAttachment_Override ¶
func NewCfnElasticLoadBalancerAttachment_Override(c CfnElasticLoadBalancerAttachment, scope constructs.Construct, id *string, props *CfnElasticLoadBalancerAttachmentProps)
func NewCfnInstance_Override ¶
func NewCfnInstance_Override(c CfnInstance, scope constructs.Construct, id *string, props *CfnInstanceProps)
func NewCfnLayer_Override ¶
func NewCfnLayer_Override(c CfnLayer, scope constructs.Construct, id *string, props *CfnLayerProps)
func NewCfnStack_Override ¶
func NewCfnStack_Override(c CfnStack, scope constructs.Construct, id *string, props *CfnStackProps)
func NewCfnUserProfile_Override ¶
func NewCfnUserProfile_Override(c CfnUserProfile, scope constructs.Construct, id *string, props *CfnUserProfileProps)
func NewCfnVolume_Override ¶
func NewCfnVolume_Override(c CfnVolume, scope constructs.Construct, id *string, props *CfnVolumeProps)
Types ¶
type CfnApp ¶
type CfnApp interface { awscdk.CfnResource awscdk.IInspectable // A `Source` object that specifies the app repository. AppSource() interface{} SetAppSource(val interface{}) // One or more user-defined key/value pairs to be added to the stack attributes. Attributes() interface{} SetAttributes(val interface{}) AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The app's data source. DataSources() interface{} SetDataSources(val interface{}) // A description of the app. Description() *string SetDescription(val *string) // The app virtual host settings, with multiple domains separated by commas. Domains() *[]*string SetDomains(val *[]*string) // Whether to enable SSL for the app. EnableSsl() interface{} SetEnableSsl(val interface{}) // An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app. Environment() interface{} SetEnvironment(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 app name. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The app's short name. Shortname() *string SetShortname(val *string) // An `SslConfiguration` object with the SSL configuration. SslConfiguration() interface{} SetSslConfiguration(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The stack ID. StackId() *string SetStackId(val *string) // The app type. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApp := awscdk.Aws_opsworks.NewCfnApp(this, jsii.String("MyCfnApp"), &CfnAppProps{ Name: jsii.String("name"), StackId: jsii.String("stackId"), Type: jsii.String("type"), // the properties below are optional AppSource: &SourceProperty{ Password: jsii.String("password"), Revision: jsii.String("revision"), SshKey: jsii.String("sshKey"), Type: jsii.String("type"), Url: jsii.String("url"), Username: jsii.String("username"), }, Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, DataSources: []interface{}{ &DataSourceProperty{ Arn: jsii.String("arn"), DatabaseName: jsii.String("databaseName"), Type: jsii.String("type"), }, }, Description: jsii.String("description"), Domains: []*string{ jsii.String("domains"), }, EnableSsl: jsii.Boolean(false), Environment: []interface{}{ &EnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), // the properties below are optional Secure: jsii.Boolean(false), }, }, Shortname: jsii.String("shortname"), SslConfiguration: &SslConfigurationProperty{ Certificate: jsii.String("certificate"), Chain: jsii.String("chain"), PrivateKey: jsii.String("privateKey"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html
func NewCfnApp ¶
func NewCfnApp(scope constructs.Construct, id *string, props *CfnAppProps) CfnApp
type CfnAppProps ¶
type CfnAppProps struct { // The app name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-name // Name *string `field:"required" json:"name" yaml:"name"` // The stack ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-stackid // StackId *string `field:"required" json:"stackId" yaml:"stackId"` // The app type. // // Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify `other` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type // Type *string `field:"required" json:"type" yaml:"type"` // A `Source` object that specifies the app repository. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-appsource // AppSource interface{} `field:"optional" json:"appSource" yaml:"appSource"` // One or more user-defined key/value pairs to be added to the stack attributes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-attributes // Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"` // The app's data source. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-datasources // DataSources interface{} `field:"optional" json:"dataSources" yaml:"dataSources"` // A description of the app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-description // Description *string `field:"optional" json:"description" yaml:"description"` // The app virtual host settings, with multiple domains separated by commas. // // For example: `'www.example.com, example.com'` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-domains // Domains *[]*string `field:"optional" json:"domains" yaml:"domains"` // Whether to enable SSL for the app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-enablessl // EnableSsl interface{} `field:"optional" json:"enableSsl" yaml:"enableSsl"` // An array of `EnvironmentVariable` objects that specify environment variables to be associated with the app. // // After you deploy the app, these variables are defined on the associated app server instance. For more information, see [Environment Variables](https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html#workingapps-creating-environment) . // // There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)." // // > If you have specified one or more environment variables, you cannot modify the stack's Chef version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-environment // Environment interface{} `field:"optional" json:"environment" yaml:"environment"` // The app's short name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-shortname // Shortname *string `field:"optional" json:"shortname" yaml:"shortname"` // An `SslConfiguration` object with the SSL configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-sslconfiguration // SslConfiguration interface{} `field:"optional" json:"sslConfiguration" yaml:"sslConfiguration"` }
Properties for defining a `CfnApp`.
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" cfnAppProps := &CfnAppProps{ Name: jsii.String("name"), StackId: jsii.String("stackId"), Type: jsii.String("type"), // the properties below are optional AppSource: &SourceProperty{ Password: jsii.String("password"), Revision: jsii.String("revision"), SshKey: jsii.String("sshKey"), Type: jsii.String("type"), Url: jsii.String("url"), Username: jsii.String("username"), }, Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, DataSources: []interface{}{ &DataSourceProperty{ Arn: jsii.String("arn"), DatabaseName: jsii.String("databaseName"), Type: jsii.String("type"), }, }, Description: jsii.String("description"), Domains: []*string{ jsii.String("domains"), }, EnableSsl: jsii.Boolean(false), Environment: []interface{}{ &EnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), // the properties below are optional Secure: jsii.Boolean(false), }, }, Shortname: jsii.String("shortname"), SslConfiguration: &SslConfigurationProperty{ Certificate: jsii.String("certificate"), Chain: jsii.String("chain"), PrivateKey: jsii.String("privateKey"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html
type CfnApp_DataSourceProperty ¶
type CfnApp_DataSourceProperty struct { // The data source's ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-arn // Arn *string `field:"optional" json:"arn" yaml:"arn"` // The database name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-databasename // DatabaseName *string `field:"optional" json:"databaseName" yaml:"databaseName"` // The data source's type, `AutoSelectOpsworksMysqlInstance` , `OpsworksMysqlInstance` , `RdsDbInstance` , or `None` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-datasource.html#cfn-opsworks-app-datasource-type // Type *string `field:"optional" json:"type" yaml:"type"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataSourceProperty := &DataSourceProperty{ Arn: jsii.String("arn"), DatabaseName: jsii.String("databaseName"), Type: jsii.String("type"), }
type CfnApp_EnvironmentVariableProperty ¶
type CfnApp_EnvironmentVariableProperty struct { // (Required) The environment variable's name, which can consist of up to 64 characters and must be specified. // // The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html#cfn-opsworks-app-environmentvariable-key // Key *string `field:"required" json:"key" yaml:"key"` // (Optional) The environment variable's value, which can be left empty. // // If you specify a value, it can contain up to 256 characters, which must all be printable. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html#cfn-opsworks-app-environmentvariable-value // Value *string `field:"required" json:"value" yaml:"value"` // (Optional) Whether the variable's value is returned by the `DescribeApps` action. // // To hide an environment variable's value, set `Secure` to `true` . `DescribeApps` returns `*****FILTERED*****` instead of the actual value. The default value for `Secure` is `false` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-environmentvariable.html#cfn-opsworks-app-environmentvariable-secure // Secure interface{} `field:"optional" json:"secure" yaml:"secure"` }
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" environmentVariableProperty := &EnvironmentVariableProperty{ Key: jsii.String("key"), Value: jsii.String("value"), // the properties below are optional Secure: jsii.Boolean(false), }
type CfnApp_SourceProperty ¶
type CfnApp_SourceProperty struct { // When included in a request, the parameter depends on the repository type. // // - For Amazon S3 bundles, set `Password` to the appropriate IAM secret access key. // - For HTTP bundles and Subversion repositories, set `Password` to the password. // // For more information on how to safely handle IAM credentials, see [](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) . // // In responses, AWS OpsWorks Stacks returns `*****FILTERED*****` instead of the actual value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-password // Password *string `field:"optional" json:"password" yaml:"password"` // The application's version. // // AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-revision // Revision *string `field:"optional" json:"revision" yaml:"revision"` // In requests, the repository's SSH key. // // In responses, AWS OpsWorks Stacks returns `*****FILTERED*****` instead of the actual value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-sshkey // SshKey *string `field:"optional" json:"sshKey" yaml:"sshKey"` // The repository type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-type // Type *string `field:"optional" json:"type" yaml:"type"` // The source URL. // // The following is an example of an Amazon S3 source URL: `https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-url // Url *string `field:"optional" json:"url" yaml:"url"` // This parameter depends on the repository type. // // - For Amazon S3 bundles, set `Username` to the appropriate IAM access key ID. // - For HTTP bundles, Git repositories, and Subversion repositories, set `Username` to the user name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-username // Username *string `field:"optional" json:"username" yaml:"username"` }
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" sourceProperty := &SourceProperty{ Password: jsii.String("password"), Revision: jsii.String("revision"), SshKey: jsii.String("sshKey"), Type: jsii.String("type"), Url: jsii.String("url"), Username: jsii.String("username"), }
type CfnApp_SslConfigurationProperty ¶
type CfnApp_SslConfigurationProperty struct { // The contents of the certificate's domain.crt file. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfiguration-certificate // Certificate *string `field:"optional" json:"certificate" yaml:"certificate"` // Optional. // // Can be used to specify an intermediate certificate authority key or client authentication. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfiguration-chain // Chain *string `field:"optional" json:"chain" yaml:"chain"` // The private key; // // the contents of the certificate's domain.kex file. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-sslconfiguration.html#cfn-opsworks-app-sslconfiguration-privatekey // PrivateKey *string `field:"optional" json:"privateKey" yaml:"privateKey"` }
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" sslConfigurationProperty := &SslConfigurationProperty{ Certificate: jsii.String("certificate"), Chain: jsii.String("chain"), PrivateKey: jsii.String("privateKey"), }
type CfnElasticLoadBalancerAttachment ¶
type CfnElasticLoadBalancerAttachment interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The Elastic Load Balancing instance name. ElasticLoadBalancerName() *string SetElasticLoadBalancerName(val *string) // The AWS OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached. LayerId() *string SetLayerId(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{}) }
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" cfnElasticLoadBalancerAttachment := awscdk.Aws_opsworks.NewCfnElasticLoadBalancerAttachment(this, jsii.String("MyCfnElasticLoadBalancerAttachment"), &CfnElasticLoadBalancerAttachmentProps{ ElasticLoadBalancerName: jsii.String("elasticLoadBalancerName"), LayerId: jsii.String("layerId"), })
func NewCfnElasticLoadBalancerAttachment ¶
func NewCfnElasticLoadBalancerAttachment(scope constructs.Construct, id *string, props *CfnElasticLoadBalancerAttachmentProps) CfnElasticLoadBalancerAttachment
type CfnElasticLoadBalancerAttachmentProps ¶
type CfnElasticLoadBalancerAttachmentProps struct { // The Elastic Load Balancing instance name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elasticloadbalancerattachment.html#cfn-opsworks-elasticloadbalancerattachment-elasticloadbalancername // ElasticLoadBalancerName *string `field:"required" json:"elasticLoadBalancerName" yaml:"elasticLoadBalancerName"` // The AWS OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elasticloadbalancerattachment.html#cfn-opsworks-elasticloadbalancerattachment-layerid // LayerId *string `field:"required" json:"layerId" yaml:"layerId"` }
Properties for defining a `CfnElasticLoadBalancerAttachment`.
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" cfnElasticLoadBalancerAttachmentProps := &CfnElasticLoadBalancerAttachmentProps{ ElasticLoadBalancerName: jsii.String("elasticLoadBalancerName"), LayerId: jsii.String("layerId"), }
type CfnInstance ¶
type CfnInstance interface { awscdk.CfnResource awscdk.IInspectable // The default AWS OpsWorks Stacks agent version. // // You have the following options:. AgentVersion() *string SetAgentVersion(val *string) // A custom AMI ID to be used to create the instance. AmiId() *string SetAmiId(val *string) // The instance architecture. Architecture() *string SetArchitecture(val *string) // The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` . AttrAvailabilityZone() *string AttrId() *string // The private DNS name of the AWS OpsWorks instance. AttrPrivateDnsName() *string // The private IP address of the AWS OpsWorks instance, such as `192.0.2.0` . AttrPrivateIp() *string // The public DNS name of the AWS OpsWorks instance. AttrPublicDnsName() *string // The public IP address of the AWS OpsWorks instance, such as `192.0.2.0` . // // > Use this attribute only when the AWS OpsWorks instance is in an AWS OpsWorks layer that auto-assigns public IP addresses. AttrPublicIp() *string // For load-based or time-based instances, the type. AutoScalingType() *string SetAutoScalingType(val *string) // The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` . AvailabilityZone() *string SetAvailabilityZone(val *string) // An array of `BlockDeviceMapping` objects that specify the instance's block devices. BlockDeviceMappings() interface{} SetBlockDeviceMappings(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Whether to create an Amazon EBS-optimized instance. EbsOptimized() interface{} SetEbsOptimized(val interface{}) // A list of Elastic IP addresses to associate with the instance. ElasticIps() *[]*string SetElasticIps(val *[]*string) // The instance host name. // // The following are character limits for instance host names. Hostname() *string SetHostname(val *string) // Whether to install operating system and package updates when the instance boots. InstallUpdatesOnBoot() interface{} SetInstallUpdatesOnBoot(val interface{}) // The instance type, such as `t2.micro` . For a list of supported instance types, open the stack in the console, choose *Instances* , and choose *+ Instance* . The *Size* list contains the currently supported types. For more information, see [Instance Families and Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) . The parameter values that you use to specify the various types are in the *API Name* column of the *Available Instance Types* table. InstanceType() *string SetInstanceType(val *string) // An array that contains the instance's layer IDs. LayerIds() *[]*string SetLayerIds(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 instance's operating system, which must be set to one of the following. Os() *string SetOs(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 instance root device type. RootDeviceType() *string SetRootDeviceType(val *string) // The instance's Amazon EC2 key-pair name. SshKeyName() *string SetSshKeyName(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The stack ID. StackId() *string SetStackId(val *string) // The ID of the instance's subnet. SubnetId() *string SetSubnetId(val *string) // The instance's tenancy option. Tenancy() *string SetTenancy(val *string) // The time-based scaling configuration for the instance. TimeBasedAutoScaling() interface{} SetTimeBasedAutoScaling(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The instance's virtualization type, `paravirtual` or `hvm` . VirtualizationType() *string SetVirtualizationType(val *string) // A list of AWS OpsWorks volume IDs to associate with the instance. Volumes() *[]*string SetVolumes(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{}) }
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnInstance := awscdk.Aws_opsworks.NewCfnInstance(this, jsii.String("MyCfnInstance"), &CfnInstanceProps{ InstanceType: jsii.String("instanceType"), LayerIds: []*string{ jsii.String("layerIds"), }, StackId: jsii.String("stackId"), // the properties below are optional AgentVersion: jsii.String("agentVersion"), AmiId: jsii.String("amiId"), Architecture: jsii.String("architecture"), AutoScalingType: jsii.String("autoScalingType"), AvailabilityZone: jsii.String("availabilityZone"), BlockDeviceMappings: []interface{}{ &BlockDeviceMappingProperty{ DeviceName: jsii.String("deviceName"), Ebs: &EbsBlockDeviceProperty{ DeleteOnTermination: jsii.Boolean(false), Iops: jsii.Number(123), SnapshotId: jsii.String("snapshotId"), VolumeSize: jsii.Number(123), VolumeType: jsii.String("volumeType"), }, NoDevice: jsii.String("noDevice"), VirtualName: jsii.String("virtualName"), }, }, EbsOptimized: jsii.Boolean(false), ElasticIps: []*string{ jsii.String("elasticIps"), }, Hostname: jsii.String("hostname"), InstallUpdatesOnBoot: jsii.Boolean(false), Os: jsii.String("os"), RootDeviceType: jsii.String("rootDeviceType"), SshKeyName: jsii.String("sshKeyName"), SubnetId: jsii.String("subnetId"), Tenancy: jsii.String("tenancy"), TimeBasedAutoScaling: &TimeBasedAutoScalingProperty{ Friday: map[string]*string{ "fridayKey": jsii.String("friday"), }, Monday: map[string]*string{ "mondayKey": jsii.String("monday"), }, Saturday: map[string]*string{ "saturdayKey": jsii.String("saturday"), }, Sunday: map[string]*string{ "sundayKey": jsii.String("sunday"), }, Thursday: map[string]*string{ "thursdayKey": jsii.String("thursday"), }, Tuesday: map[string]*string{ "tuesdayKey": jsii.String("tuesday"), }, Wednesday: map[string]*string{ "wednesdayKey": jsii.String("wednesday"), }, }, VirtualizationType: jsii.String("virtualizationType"), Volumes: []*string{ jsii.String("volumes"), }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html
func NewCfnInstance ¶
func NewCfnInstance(scope constructs.Construct, id *string, props *CfnInstanceProps) CfnInstance
type CfnInstanceProps ¶
type CfnInstanceProps struct { // The instance type, such as `t2.micro` . For a list of supported instance types, open the stack in the console, choose *Instances* , and choose *+ Instance* . The *Size* list contains the currently supported types. For more information, see [Instance Families and Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) . The parameter values that you use to specify the various types are in the *API Name* column of the *Available Instance Types* table. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-instancetype // InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"` // An array that contains the instance's layer IDs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-layerids // LayerIds *[]*string `field:"required" json:"layerIds" yaml:"layerIds"` // The stack ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-stackid // StackId *string `field:"required" json:"stackId" yaml:"stackId"` // The default AWS OpsWorks Stacks agent version. You have the following options:. // // - `INHERIT` - Use the stack's default agent version setting. // - *version_number* - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks installs that version on the instance. // // The default setting is `INHERIT` . To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call `DescribeAgentVersions` . AgentVersion cannot be set to Chef 12.2. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-agentversion // AgentVersion *string `field:"optional" json:"agentVersion" yaml:"agentVersion"` // A custom AMI ID to be used to create the instance. // // The AMI should be based on one of the supported operating systems. For more information, see [Using Custom AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) . // // > If you specify a custom AMI, you must set `Os` to `Custom` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-amiid // AmiId *string `field:"optional" json:"amiId" yaml:"amiId"` // The instance architecture. // // The default option is `x86_64` . Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see [Instance Families and Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-architecture // Architecture *string `field:"optional" json:"architecture" yaml:"architecture"` // For load-based or time-based instances, the type. // // Windows stacks can use only time-based instances. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-autoscalingtype // AutoScalingType *string `field:"optional" json:"autoScalingType" yaml:"autoScalingType"` // The Availability Zone of the AWS OpsWorks instance, such as `us-east-2a` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-availabilityzone // AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"` // An array of `BlockDeviceMapping` objects that specify the instance's block devices. // // For more information, see [Block Device Mapping](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) . Note that block device mappings are not supported for custom AMIs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-blockdevicemappings // BlockDeviceMappings interface{} `field:"optional" json:"blockDeviceMappings" yaml:"blockDeviceMappings"` // Whether to create an Amazon EBS-optimized instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-ebsoptimized // EbsOptimized interface{} `field:"optional" json:"ebsOptimized" yaml:"ebsOptimized"` // A list of Elastic IP addresses to associate with the instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-elasticips // ElasticIps *[]*string `field:"optional" json:"elasticIps" yaml:"elasticIps"` // The instance host name. The following are character limits for instance host names. // // - Linux-based instances: 63 characters // - Windows-based instances: 15 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-hostname // Hostname *string `field:"optional" json:"hostname" yaml:"hostname"` // Whether to install operating system and package updates when the instance boots. // // The default value is `true` . To control when updates are installed, set this value to `false` . You must then update your instances manually by using `CreateDeployment` to run the `update_dependencies` stack command or by manually running `yum` (Amazon Linux) or `apt-get` (Ubuntu) on the instances. // // > We strongly recommend using the default value of `true` to ensure that your instances have the latest security updates. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-installupdatesonboot // InstallUpdatesOnBoot interface{} `field:"optional" json:"installUpdatesOnBoot" yaml:"installUpdatesOnBoot"` // The instance's operating system, which must be set to one of the following. // // - A supported Linux operating system: An Amazon Linux version, such as `Amazon Linux 2` , `Amazon Linux 2018.03` , `Amazon Linux 2017.09` , `Amazon Linux 2017.03` , `Amazon Linux 2016.09` , `Amazon Linux 2016.03` , `Amazon Linux 2015.09` , or `Amazon Linux 2015.03` . // - A supported Ubuntu operating system, such as `Ubuntu 18.04 LTS` , `Ubuntu 16.04 LTS` , `Ubuntu 14.04 LTS` , or `Ubuntu 12.04 LTS` . // - `CentOS Linux 7` // - `Red Hat Enterprise Linux 7` // - A supported Windows operating system, such as `Microsoft Windows Server 2012 R2 Base` , `Microsoft Windows Server 2012 R2 with SQL Server Express` , `Microsoft Windows Server 2012 R2 with SQL Server Standard` , or `Microsoft Windows Server 2012 R2 with SQL Server Web` . // - A custom AMI: `Custom` . // // Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see [AWS OpsWorks Stacks Operating Systems](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) . // // The default option is the current Amazon Linux version. If you set this parameter to `Custom` , you must use the `CreateInstance` action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is `Custom` . For more information about how to use custom AMIs with AWS OpsWorks Stacks, see [Using Custom AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-os // Os *string `field:"optional" json:"os" yaml:"os"` // The instance root device type. // // For more information, see [Storage for the Root Device](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-rootdevicetype // RootDeviceType *string `field:"optional" json:"rootDeviceType" yaml:"rootDeviceType"` // The instance's Amazon EC2 key-pair name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-sshkeyname // SshKeyName *string `field:"optional" json:"sshKeyName" yaml:"sshKeyName"` // The ID of the instance's subnet. // // If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-subnetid // SubnetId *string `field:"optional" json:"subnetId" yaml:"subnetId"` // The instance's tenancy option. // // The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: `dedicated` , `default` , or `host` . Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see [Dedicated Hosts Overview](https://docs.aws.amazon.com/ec2/dedicated-hosts/) and [Amazon EC2 Dedicated Hosts](https://docs.aws.amazon.com/ec2/dedicated-hosts/) . For more information about dedicated instances, see [Dedicated Instances](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html) and [Amazon EC2 Dedicated Instances](https://docs.aws.amazon.com/ec2/purchasing-options/dedicated-instances/) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-tenancy // Tenancy *string `field:"optional" json:"tenancy" yaml:"tenancy"` // The time-based scaling configuration for the instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-timebasedautoscaling // TimeBasedAutoScaling interface{} `field:"optional" json:"timeBasedAutoScaling" yaml:"timeBasedAutoScaling"` // The instance's virtualization type, `paravirtual` or `hvm` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-virtualizationtype // VirtualizationType *string `field:"optional" json:"virtualizationType" yaml:"virtualizationType"` // A list of AWS OpsWorks volume IDs to associate with the instance. // // For more information, see [`AWS::OpsWorks::Volume`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-volumes // Volumes *[]*string `field:"optional" json:"volumes" yaml:"volumes"` }
Properties for defining a `CfnInstance`.
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" cfnInstanceProps := &CfnInstanceProps{ InstanceType: jsii.String("instanceType"), LayerIds: []*string{ jsii.String("layerIds"), }, StackId: jsii.String("stackId"), // the properties below are optional AgentVersion: jsii.String("agentVersion"), AmiId: jsii.String("amiId"), Architecture: jsii.String("architecture"), AutoScalingType: jsii.String("autoScalingType"), AvailabilityZone: jsii.String("availabilityZone"), BlockDeviceMappings: []interface{}{ &BlockDeviceMappingProperty{ DeviceName: jsii.String("deviceName"), Ebs: &EbsBlockDeviceProperty{ DeleteOnTermination: jsii.Boolean(false), Iops: jsii.Number(123), SnapshotId: jsii.String("snapshotId"), VolumeSize: jsii.Number(123), VolumeType: jsii.String("volumeType"), }, NoDevice: jsii.String("noDevice"), VirtualName: jsii.String("virtualName"), }, }, EbsOptimized: jsii.Boolean(false), ElasticIps: []*string{ jsii.String("elasticIps"), }, Hostname: jsii.String("hostname"), InstallUpdatesOnBoot: jsii.Boolean(false), Os: jsii.String("os"), RootDeviceType: jsii.String("rootDeviceType"), SshKeyName: jsii.String("sshKeyName"), SubnetId: jsii.String("subnetId"), Tenancy: jsii.String("tenancy"), TimeBasedAutoScaling: &TimeBasedAutoScalingProperty{ Friday: map[string]*string{ "fridayKey": jsii.String("friday"), }, Monday: map[string]*string{ "mondayKey": jsii.String("monday"), }, Saturday: map[string]*string{ "saturdayKey": jsii.String("saturday"), }, Sunday: map[string]*string{ "sundayKey": jsii.String("sunday"), }, Thursday: map[string]*string{ "thursdayKey": jsii.String("thursday"), }, Tuesday: map[string]*string{ "tuesdayKey": jsii.String("tuesday"), }, Wednesday: map[string]*string{ "wednesdayKey": jsii.String("wednesday"), }, }, VirtualizationType: jsii.String("virtualizationType"), Volumes: []*string{ jsii.String("volumes"), }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html
type CfnInstance_BlockDeviceMappingProperty ¶
type CfnInstance_BlockDeviceMappingProperty struct { // The device name that is exposed to the instance, such as `/dev/sdh` . // // For the root device, you can use the explicit device name or you can set this parameter to `ROOT_DEVICE` and AWS OpsWorks Stacks will provide the correct device name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-devicename // DeviceName *string `field:"optional" json:"deviceName" yaml:"deviceName"` // An `EBSBlockDevice` that defines how to configure an Amazon EBS volume when the instance is launched. // // You can specify either the `VirtualName` or `Ebs` , but not both. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-ebs // Ebs interface{} `field:"optional" json:"ebs" yaml:"ebs"` // Suppresses the specified device included in the AMI's block device mapping. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-nodevice // NoDevice *string `field:"optional" json:"noDevice" yaml:"noDevice"` // The virtual device name. // // For more information, see [BlockDeviceMapping](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html) . You can specify either the `VirtualName` or `Ebs` , but not both. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-virtualname // VirtualName *string `field:"optional" json:"virtualName" yaml:"virtualName"` }
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" blockDeviceMappingProperty := &BlockDeviceMappingProperty{ DeviceName: jsii.String("deviceName"), Ebs: &EbsBlockDeviceProperty{ DeleteOnTermination: jsii.Boolean(false), Iops: jsii.Number(123), SnapshotId: jsii.String("snapshotId"), VolumeSize: jsii.Number(123), VolumeType: jsii.String("volumeType"), }, NoDevice: jsii.String("noDevice"), VirtualName: jsii.String("virtualName"), }
type CfnInstance_EbsBlockDeviceProperty ¶
type CfnInstance_EbsBlockDeviceProperty struct { // Whether the volume is deleted on instance termination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-deleteontermination // DeleteOnTermination interface{} `field:"optional" json:"deleteOnTermination" yaml:"deleteOnTermination"` // The number of I/O operations per second (IOPS) that the volume supports. // // For more information, see [EbsBlockDevice](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-iops // Iops *float64 `field:"optional" json:"iops" yaml:"iops"` // The snapshot ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-snapshotid // SnapshotId *string `field:"optional" json:"snapshotId" yaml:"snapshotId"` // The volume size, in GiB. // // For more information, see [EbsBlockDevice](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EbsBlockDevice.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumesize // VolumeSize *float64 `field:"optional" json:"volumeSize" yaml:"volumeSize"` // The volume type. // // `gp2` for General Purpose (SSD) volumes, `io1` for Provisioned IOPS (SSD) volumes, `st1` for Throughput Optimized hard disk drives (HDD), `sc1` for Cold HDD,and `standard` for Magnetic volumes. // // If you specify the `io1` volume type, you must also specify a value for the `Iops` attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-ebsblockdevice.html#cfn-opsworks-instance-ebsblockdevice-volumetype // VolumeType *string `field:"optional" json:"volumeType" yaml:"volumeType"` }
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" ebsBlockDeviceProperty := &EbsBlockDeviceProperty{ DeleteOnTermination: jsii.Boolean(false), Iops: jsii.Number(123), SnapshotId: jsii.String("snapshotId"), VolumeSize: jsii.Number(123), VolumeType: jsii.String("volumeType"), }
type CfnInstance_TimeBasedAutoScalingProperty ¶
type CfnInstance_TimeBasedAutoScalingProperty struct { // The schedule for Friday. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-friday // Friday interface{} `field:"optional" json:"friday" yaml:"friday"` // The schedule for Monday. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-monday // Monday interface{} `field:"optional" json:"monday" yaml:"monday"` // The schedule for Saturday. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-saturday // Saturday interface{} `field:"optional" json:"saturday" yaml:"saturday"` // The schedule for Sunday. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-sunday // Sunday interface{} `field:"optional" json:"sunday" yaml:"sunday"` // The schedule for Thursday. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-thursday // Thursday interface{} `field:"optional" json:"thursday" yaml:"thursday"` // The schedule for Tuesday. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-tuesday // Tuesday interface{} `field:"optional" json:"tuesday" yaml:"tuesday"` // The schedule for Wednesday. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-timebasedautoscaling.html#cfn-opsworks-instance-timebasedautoscaling-wednesday // Wednesday interface{} `field:"optional" json:"wednesday" yaml:"wednesday"` }
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" timeBasedAutoScalingProperty := &TimeBasedAutoScalingProperty{ Friday: map[string]*string{ "fridayKey": jsii.String("friday"), }, Monday: map[string]*string{ "mondayKey": jsii.String("monday"), }, Saturday: map[string]*string{ "saturdayKey": jsii.String("saturday"), }, Sunday: map[string]*string{ "sundayKey": jsii.String("sunday"), }, Thursday: map[string]*string{ "thursdayKey": jsii.String("thursday"), }, Tuesday: map[string]*string{ "tuesdayKey": jsii.String("tuesday"), }, Wednesday: map[string]*string{ "wednesdayKey": jsii.String("wednesday"), }, }
type CfnLayer ¶
type CfnLayer interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // One or more user-defined key-value pairs to be added to the stack attributes. Attributes() interface{} SetAttributes(val interface{}) AttrId() *string // Whether to automatically assign an [Elastic IP address](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) to the layer's instances. For more information, see [How to Edit a Layer](https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) . AutoAssignElasticIps() interface{} SetAutoAssignElasticIps(val interface{}) // For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. AutoAssignPublicIps() interface{} SetAutoAssignPublicIps(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The ARN of an IAM profile to be used for the layer's EC2 instances. CustomInstanceProfileArn() *string SetCustomInstanceProfileArn(val *string) // A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. CustomJson() interface{} SetCustomJson(val interface{}) // A `LayerCustomRecipes` object that specifies the layer custom recipes. CustomRecipes() interface{} SetCustomRecipes(val interface{}) // An array containing the layer custom security group IDs. CustomSecurityGroupIds() *[]*string SetCustomSecurityGroupIds(val *[]*string) // Whether to disable auto healing for the layer. EnableAutoHealing() interface{} SetEnableAutoHealing(val interface{}) // Whether to install operating system and package updates when the instance boots. InstallUpdatesOnBoot() interface{} SetInstallUpdatesOnBoot(val interface{}) // A `LifeCycleEventConfiguration` object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining. LifecycleEventConfiguration() interface{} SetLifecycleEventConfiguration(val interface{}) // The load-based scaling configuration for the AWS OpsWorks layer. LoadBasedAutoScaling() interface{} SetLoadBasedAutoScaling(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 layer name, which is used by the console. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // An array of `Package` objects that describes the layer packages. Packages() *[]*string SetPackages(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 // For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. Shortname() *string SetShortname(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The layer stack ID. StackId() *string SetStackId(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Specifies one or more sets of tags (key–value pairs) to associate with this AWS OpsWorks layer. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The layer type. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Whether to use Amazon EBS-optimized instances. UseEbsOptimizedInstances() interface{} SetUseEbsOptimizedInstances(val interface{}) // A `VolumeConfigurations` object that describes the layer's Amazon EBS volumes. VolumeConfigurations() interface{} SetVolumeConfigurations(val interface{}) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customJson interface{} cfnLayer := awscdk.Aws_opsworks.NewCfnLayer(this, jsii.String("MyCfnLayer"), &CfnLayerProps{ AutoAssignElasticIps: jsii.Boolean(false), AutoAssignPublicIps: jsii.Boolean(false), EnableAutoHealing: jsii.Boolean(false), Name: jsii.String("name"), Shortname: jsii.String("shortname"), StackId: jsii.String("stackId"), Type: jsii.String("type"), // the properties below are optional Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, CustomInstanceProfileArn: jsii.String("customInstanceProfileArn"), CustomJson: customJson, CustomRecipes: &RecipesProperty{ Configure: []*string{ jsii.String("configure"), }, Deploy: []*string{ jsii.String("deploy"), }, Setup: []*string{ jsii.String("setup"), }, Shutdown: []*string{ jsii.String("shutdown"), }, Undeploy: []*string{ jsii.String("undeploy"), }, }, CustomSecurityGroupIds: []*string{ jsii.String("customSecurityGroupIds"), }, InstallUpdatesOnBoot: jsii.Boolean(false), LifecycleEventConfiguration: &LifecycleEventConfigurationProperty{ ShutdownEventConfiguration: &ShutdownEventConfigurationProperty{ DelayUntilElbConnectionsDrained: jsii.Boolean(false), ExecutionTimeout: jsii.Number(123), }, }, LoadBasedAutoScaling: &LoadBasedAutoScalingProperty{ DownScaling: &AutoScalingThresholdsProperty{ CpuThreshold: jsii.Number(123), IgnoreMetricsTime: jsii.Number(123), InstanceCount: jsii.Number(123), LoadThreshold: jsii.Number(123), MemoryThreshold: jsii.Number(123), ThresholdsWaitTime: jsii.Number(123), }, Enable: jsii.Boolean(false), UpScaling: &AutoScalingThresholdsProperty{ CpuThreshold: jsii.Number(123), IgnoreMetricsTime: jsii.Number(123), InstanceCount: jsii.Number(123), LoadThreshold: jsii.Number(123), MemoryThreshold: jsii.Number(123), ThresholdsWaitTime: jsii.Number(123), }, }, Packages: []*string{ jsii.String("packages"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, UseEbsOptimizedInstances: jsii.Boolean(false), VolumeConfigurations: []interface{}{ &VolumeConfigurationProperty{ Encrypted: jsii.Boolean(false), Iops: jsii.Number(123), MountPoint: jsii.String("mountPoint"), NumberOfDisks: jsii.Number(123), RaidLevel: jsii.Number(123), Size: jsii.Number(123), VolumeType: jsii.String("volumeType"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html
func NewCfnLayer ¶
func NewCfnLayer(scope constructs.Construct, id *string, props *CfnLayerProps) CfnLayer
type CfnLayerProps ¶
type CfnLayerProps struct { // Whether to automatically assign an [Elastic IP address](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) to the layer's instances. For more information, see [How to Edit a Layer](https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignelasticips // AutoAssignElasticIps interface{} `field:"required" json:"autoAssignElasticIps" yaml:"autoAssignElasticIps"` // For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. // // For more information, see [How to Edit a Layer](https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-autoassignpublicips // AutoAssignPublicIps interface{} `field:"required" json:"autoAssignPublicIps" yaml:"autoAssignPublicIps"` // Whether to disable auto healing for the layer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-enableautohealing // EnableAutoHealing interface{} `field:"required" json:"enableAutoHealing" yaml:"enableAutoHealing"` // The layer name, which is used by the console. // // Layer names can be a maximum of 32 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-name // Name *string `field:"required" json:"name" yaml:"name"` // For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef recipes. // // The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. // // Built-in layer short names are defined by AWS OpsWorks Stacks. For more information, see the [Layer Reference](https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-shortname // Shortname *string `field:"required" json:"shortname" yaml:"shortname"` // The layer stack ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-stackid // StackId *string `field:"required" json:"stackId" yaml:"stackId"` // The layer type. // // A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-type // Type *string `field:"required" json:"type" yaml:"type"` // One or more user-defined key-value pairs to be added to the stack attributes. // // To create a cluster layer, set the `EcsClusterArn` attribute to the cluster's ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-attributes // Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"` // The ARN of an IAM profile to be used for the layer's EC2 instances. // // For more information about IAM ARNs, see [Using Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-custominstanceprofilearn // CustomInstanceProfileArn *string `field:"optional" json:"customInstanceProfileArn" yaml:"customInstanceProfileArn"` // A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. // // For more information, see [Using Custom JSON](https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html) . This feature is supported as of version 1.7.42 of the AWS CLI . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customjson // CustomJson interface{} `field:"optional" json:"customJson" yaml:"customJson"` // A `LayerCustomRecipes` object that specifies the layer custom recipes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customrecipes // CustomRecipes interface{} `field:"optional" json:"customRecipes" yaml:"customRecipes"` // An array containing the layer custom security group IDs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-customsecuritygroupids // CustomSecurityGroupIds *[]*string `field:"optional" json:"customSecurityGroupIds" yaml:"customSecurityGroupIds"` // Whether to install operating system and package updates when the instance boots. // // The default value is `true` . To control when updates are installed, set this value to `false` . You must then update your instances manually by using `CreateDeployment` to run the `update_dependencies` stack command or by manually running `yum` (Amazon Linux) or `apt-get` (Ubuntu) on the instances. // // > To ensure that your instances have the latest security updates, we strongly recommend using the default value of `true` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-installupdatesonboot // InstallUpdatesOnBoot interface{} `field:"optional" json:"installUpdatesOnBoot" yaml:"installUpdatesOnBoot"` // A `LifeCycleEventConfiguration` object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-lifecycleeventconfiguration // LifecycleEventConfiguration interface{} `field:"optional" json:"lifecycleEventConfiguration" yaml:"lifecycleEventConfiguration"` // The load-based scaling configuration for the AWS OpsWorks layer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-loadbasedautoscaling // LoadBasedAutoScaling interface{} `field:"optional" json:"loadBasedAutoScaling" yaml:"loadBasedAutoScaling"` // An array of `Package` objects that describes the layer packages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-packages // Packages *[]*string `field:"optional" json:"packages" yaml:"packages"` // Specifies one or more sets of tags (key–value pairs) to associate with this AWS OpsWorks layer. // // Use tags to manage your resources. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Whether to use Amazon EBS-optimized instances. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-useebsoptimizedinstances // UseEbsOptimizedInstances interface{} `field:"optional" json:"useEbsOptimizedInstances" yaml:"useEbsOptimizedInstances"` // A `VolumeConfigurations` object that describes the layer's Amazon EBS volumes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-volumeconfigurations // VolumeConfigurations interface{} `field:"optional" json:"volumeConfigurations" yaml:"volumeConfigurations"` }
Properties for defining a `CfnLayer`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customJson interface{} cfnLayerProps := &CfnLayerProps{ AutoAssignElasticIps: jsii.Boolean(false), AutoAssignPublicIps: jsii.Boolean(false), EnableAutoHealing: jsii.Boolean(false), Name: jsii.String("name"), Shortname: jsii.String("shortname"), StackId: jsii.String("stackId"), Type: jsii.String("type"), // the properties below are optional Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, CustomInstanceProfileArn: jsii.String("customInstanceProfileArn"), CustomJson: customJson, CustomRecipes: &RecipesProperty{ Configure: []*string{ jsii.String("configure"), }, Deploy: []*string{ jsii.String("deploy"), }, Setup: []*string{ jsii.String("setup"), }, Shutdown: []*string{ jsii.String("shutdown"), }, Undeploy: []*string{ jsii.String("undeploy"), }, }, CustomSecurityGroupIds: []*string{ jsii.String("customSecurityGroupIds"), }, InstallUpdatesOnBoot: jsii.Boolean(false), LifecycleEventConfiguration: &LifecycleEventConfigurationProperty{ ShutdownEventConfiguration: &ShutdownEventConfigurationProperty{ DelayUntilElbConnectionsDrained: jsii.Boolean(false), ExecutionTimeout: jsii.Number(123), }, }, LoadBasedAutoScaling: &LoadBasedAutoScalingProperty{ DownScaling: &AutoScalingThresholdsProperty{ CpuThreshold: jsii.Number(123), IgnoreMetricsTime: jsii.Number(123), InstanceCount: jsii.Number(123), LoadThreshold: jsii.Number(123), MemoryThreshold: jsii.Number(123), ThresholdsWaitTime: jsii.Number(123), }, Enable: jsii.Boolean(false), UpScaling: &AutoScalingThresholdsProperty{ CpuThreshold: jsii.Number(123), IgnoreMetricsTime: jsii.Number(123), InstanceCount: jsii.Number(123), LoadThreshold: jsii.Number(123), MemoryThreshold: jsii.Number(123), ThresholdsWaitTime: jsii.Number(123), }, }, Packages: []*string{ jsii.String("packages"), }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, UseEbsOptimizedInstances: jsii.Boolean(false), VolumeConfigurations: []interface{}{ &VolumeConfigurationProperty{ Encrypted: jsii.Boolean(false), Iops: jsii.Number(123), MountPoint: jsii.String("mountPoint"), NumberOfDisks: jsii.Number(123), RaidLevel: jsii.Number(123), Size: jsii.Number(123), VolumeType: jsii.String("volumeType"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html
type CfnLayer_AutoScalingThresholdsProperty ¶
type CfnLayer_AutoScalingThresholdsProperty struct { // The CPU utilization threshold, as a percent of the available CPU. // // A value of -1 disables the threshold. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-autoscalingthresholds.html#cfn-opsworks-layer-autoscalingthresholds-cputhreshold // CpuThreshold *float64 `field:"optional" json:"cpuThreshold" yaml:"cpuThreshold"` // The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. // // For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. `IgnoreMetricsTime` allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-autoscalingthresholds.html#cfn-opsworks-layer-autoscalingthresholds-ignoremetricstime // IgnoreMetricsTime *float64 `field:"optional" json:"ignoreMetricsTime" yaml:"ignoreMetricsTime"` // The number of instances to add or remove when the load exceeds a threshold. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-autoscalingthresholds.html#cfn-opsworks-layer-autoscalingthresholds-instancecount // InstanceCount *float64 `field:"optional" json:"instanceCount" yaml:"instanceCount"` // The load threshold. // // A value of -1 disables the threshold. For more information about how load is computed, see [Load (computing)](https://docs.aws.amazon.com/http://en.wikipedia.org/wiki/Load_%28computing%29) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-autoscalingthresholds.html#cfn-opsworks-layer-autoscalingthresholds-loadthreshold // LoadThreshold *float64 `field:"optional" json:"loadThreshold" yaml:"loadThreshold"` // The memory utilization threshold, as a percent of the available memory. // // A value of -1 disables the threshold. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-autoscalingthresholds.html#cfn-opsworks-layer-autoscalingthresholds-memorythreshold // MemoryThreshold *float64 `field:"optional" json:"memoryThreshold" yaml:"memoryThreshold"` // The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-autoscalingthresholds.html#cfn-opsworks-layer-autoscalingthresholds-thresholdswaittime // ThresholdsWaitTime *float64 `field:"optional" json:"thresholdsWaitTime" yaml:"thresholdsWaitTime"` }
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" autoScalingThresholdsProperty := &AutoScalingThresholdsProperty{ CpuThreshold: jsii.Number(123), IgnoreMetricsTime: jsii.Number(123), InstanceCount: jsii.Number(123), LoadThreshold: jsii.Number(123), MemoryThreshold: jsii.Number(123), ThresholdsWaitTime: jsii.Number(123), }
type CfnLayer_LifecycleEventConfigurationProperty ¶
type CfnLayer_LifecycleEventConfigurationProperty struct { // The Shutdown event configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-lifecycleeventconfiguration.html#cfn-opsworks-layer-lifecycleeventconfiguration-shutdowneventconfiguration // ShutdownEventConfiguration interface{} `field:"optional" json:"shutdownEventConfiguration" yaml:"shutdownEventConfiguration"` }
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" lifecycleEventConfigurationProperty := &LifecycleEventConfigurationProperty{ ShutdownEventConfiguration: &ShutdownEventConfigurationProperty{ DelayUntilElbConnectionsDrained: jsii.Boolean(false), ExecutionTimeout: jsii.Number(123), }, }
type CfnLayer_LoadBasedAutoScalingProperty ¶
type CfnLayer_LoadBasedAutoScalingProperty struct { // An `AutoScalingThresholds` object that describes the downscaling configuration, which defines how and when AWS OpsWorks Stacks reduces the number of instances. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-downscaling // DownScaling interface{} `field:"optional" json:"downScaling" yaml:"downScaling"` // Whether load-based auto scaling is enabled for the layer. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-enable // Enable interface{} `field:"optional" json:"enable" yaml:"enable"` // An `AutoScalingThresholds` object that describes the upscaling configuration, which defines how and when AWS OpsWorks Stacks increases the number of instances. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-upscaling // UpScaling interface{} `field:"optional" json:"upScaling" yaml:"upScaling"` }
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" loadBasedAutoScalingProperty := &LoadBasedAutoScalingProperty{ DownScaling: &AutoScalingThresholdsProperty{ CpuThreshold: jsii.Number(123), IgnoreMetricsTime: jsii.Number(123), InstanceCount: jsii.Number(123), LoadThreshold: jsii.Number(123), MemoryThreshold: jsii.Number(123), ThresholdsWaitTime: jsii.Number(123), }, Enable: jsii.Boolean(false), UpScaling: &AutoScalingThresholdsProperty{ CpuThreshold: jsii.Number(123), IgnoreMetricsTime: jsii.Number(123), InstanceCount: jsii.Number(123), LoadThreshold: jsii.Number(123), MemoryThreshold: jsii.Number(123), ThresholdsWaitTime: jsii.Number(123), }, }
type CfnLayer_RecipesProperty ¶
type CfnLayer_RecipesProperty struct { // An array of custom recipe names to be run following a `configure` event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-configure // Configure *[]*string `field:"optional" json:"configure" yaml:"configure"` // An array of custom recipe names to be run following a `deploy` event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-deploy // Deploy *[]*string `field:"optional" json:"deploy" yaml:"deploy"` // An array of custom recipe names to be run following a `setup` event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-setup // Setup *[]*string `field:"optional" json:"setup" yaml:"setup"` // An array of custom recipe names to be run following a `shutdown` event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-shutdown // Shutdown *[]*string `field:"optional" json:"shutdown" yaml:"shutdown"` // An array of custom recipe names to be run following a `undeploy` event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-recipes.html#cfn-opsworks-layer-recipes-undeploy // Undeploy *[]*string `field:"optional" json:"undeploy" yaml:"undeploy"` }
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" recipesProperty := &RecipesProperty{ Configure: []*string{ jsii.String("configure"), }, Deploy: []*string{ jsii.String("deploy"), }, Setup: []*string{ jsii.String("setup"), }, Shutdown: []*string{ jsii.String("shutdown"), }, Undeploy: []*string{ jsii.String("undeploy"), }, }
type CfnLayer_ShutdownEventConfigurationProperty ¶
type CfnLayer_ShutdownEventConfigurationProperty struct { // Whether to enable Elastic Load Balancing connection draining. // // For more information, see [Connection Draining](https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain) // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-shutdowneventconfiguration.html#cfn-opsworks-layer-shutdowneventconfiguration-delayuntilelbconnectionsdrained // DelayUntilElbConnectionsDrained interface{} `field:"optional" json:"delayUntilElbConnectionsDrained" yaml:"delayUntilElbConnectionsDrained"` // The time, in seconds, that AWS OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-shutdowneventconfiguration.html#cfn-opsworks-layer-shutdowneventconfiguration-executiontimeout // ExecutionTimeout *float64 `field:"optional" json:"executionTimeout" yaml:"executionTimeout"` }
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" shutdownEventConfigurationProperty := &ShutdownEventConfigurationProperty{ DelayUntilElbConnectionsDrained: jsii.Boolean(false), ExecutionTimeout: jsii.Number(123), }
type CfnLayer_VolumeConfigurationProperty ¶
type CfnLayer_VolumeConfigurationProperty struct { // Specifies whether an Amazon EBS volume is encrypted. // // For more information, see [Amazon EBS Encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-encrypted // Encrypted interface{} `field:"optional" json:"encrypted" yaml:"encrypted"` // The number of I/O operations per second (IOPS) to provision for the volume. // // For PIOPS volumes, the IOPS per disk. // // If you specify `io1` for the volume type, you must specify this property. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-iops // Iops *float64 `field:"optional" json:"iops" yaml:"iops"` // The volume mount point. // // For example "/dev/sdh". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-mountpoint // MountPoint *string `field:"optional" json:"mountPoint" yaml:"mountPoint"` // The number of disks in the volume. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-numberofdisks // NumberOfDisks *float64 `field:"optional" json:"numberOfDisks" yaml:"numberOfDisks"` // The volume [RAID level](https://docs.aws.amazon.com/http://en.wikipedia.org/wiki/Standard_RAID_levels) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-raidlevel // RaidLevel *float64 `field:"optional" json:"raidLevel" yaml:"raidLevel"` // The volume size. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-size // Size *float64 `field:"optional" json:"size" yaml:"size"` // The volume type. For more information, see [Amazon EBS Volume Types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) . // // - `standard` - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB. // - `io1` - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB. // - `gp2` - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB. // - `st1` - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. // - `sc1` - Cold HDD. Cold HDD volumes must have a minimum size of 125 GiB and a maximum size of 16384 GiB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-volumeconfiguration.html#cfn-opsworks-layer-volumeconfiguration-volumetype // VolumeType *string `field:"optional" json:"volumeType" yaml:"volumeType"` }
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" volumeConfigurationProperty := &VolumeConfigurationProperty{ Encrypted: jsii.Boolean(false), Iops: jsii.Number(123), MountPoint: jsii.String("mountPoint"), NumberOfDisks: jsii.Number(123), RaidLevel: jsii.Number(123), Size: jsii.Number(123), VolumeType: jsii.String("volumeType"), }
type CfnStack ¶
type CfnStack interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The default AWS OpsWorks Stacks agent version. // // You have the following options:. AgentVersion() *string SetAgentVersion(val *string) // One or more user-defined key-value pairs to be added to the stack attributes. Attributes() interface{} SetAttributes(val interface{}) AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see [Create a New Stack](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) . ChefConfiguration() interface{} SetChefConfiguration(val interface{}) // If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack. CloneAppIds() *[]*string SetCloneAppIds(val *[]*string) // If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions. ClonePermissions() interface{} SetClonePermissions(val interface{}) // The configuration manager. ConfigurationManager() interface{} SetConfigurationManager(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 // Contains the information required to retrieve an app or cookbook from a repository. CustomCookbooksSource() interface{} SetCustomCookbooksSource(val interface{}) // A string that contains user-defined, custom JSON. CustomJson() interface{} SetCustomJson(val interface{}) // The stack's default Availability Zone, which must be in the specified region. DefaultAvailabilityZone() *string SetDefaultAvailabilityZone(val *string) // The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. DefaultInstanceProfileArn() *string SetDefaultInstanceProfileArn(val *string) // The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. DefaultOs() *string SetDefaultOs(val *string) // The default root device type. DefaultRootDeviceType() *string SetDefaultRootDeviceType(val *string) // A default Amazon EC2 key pair name. DefaultSshKeyName() *string SetDefaultSshKeyName(val *string) // The stack's default subnet ID. DefaultSubnetId() *string SetDefaultSubnetId(val *string) // The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack. EcsClusterArn() *string SetEcsClusterArn(val *string) // A list of Elastic IP addresses to register with the AWS OpsWorks stack. ElasticIps() interface{} SetElasticIps(val interface{}) // The stack's host name theme, with spaces replaced by underscores. HostnameTheme() *string SetHostnameTheme(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 stack name. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack. RdsDbInstances() interface{} SetRdsDbInstances(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. ServiceRoleArn() *string SetServiceRoleArn(val *string) // If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone. SourceStackId() *string SetSourceStackId(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // A map that contains tag keys and tag values that are attached to a stack or layer. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Whether the stack uses custom cookbooks. UseCustomCookbooks() interface{} SetUseCustomCookbooks(val interface{}) // Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. UseOpsworksSecurityGroups() interface{} SetUseOpsworksSecurityGroups(val interface{}) // The ID of the VPC that the stack is to be launched into. 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{}) }
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customJson interface{} cfnStack := awscdk.Aws_opsworks.NewCfnStack(this, jsii.String("MyCfnStack"), &CfnStackProps{ DefaultInstanceProfileArn: jsii.String("defaultInstanceProfileArn"), Name: jsii.String("name"), ServiceRoleArn: jsii.String("serviceRoleArn"), // the properties below are optional AgentVersion: jsii.String("agentVersion"), Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, ChefConfiguration: &ChefConfigurationProperty{ BerkshelfVersion: jsii.String("berkshelfVersion"), ManageBerkshelf: jsii.Boolean(false), }, CloneAppIds: []*string{ jsii.String("cloneAppIds"), }, ClonePermissions: jsii.Boolean(false), ConfigurationManager: &StackConfigurationManagerProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, CustomCookbooksSource: &SourceProperty{ Password: jsii.String("password"), Revision: jsii.String("revision"), SshKey: jsii.String("sshKey"), Type: jsii.String("type"), Url: jsii.String("url"), Username: jsii.String("username"), }, CustomJson: customJson, DefaultAvailabilityZone: jsii.String("defaultAvailabilityZone"), DefaultOs: jsii.String("defaultOs"), DefaultRootDeviceType: jsii.String("defaultRootDeviceType"), DefaultSshKeyName: jsii.String("defaultSshKeyName"), DefaultSubnetId: jsii.String("defaultSubnetId"), EcsClusterArn: jsii.String("ecsClusterArn"), ElasticIps: []interface{}{ &ElasticIpProperty{ Ip: jsii.String("ip"), // the properties below are optional Name: jsii.String("name"), }, }, HostnameTheme: jsii.String("hostnameTheme"), RdsDbInstances: []interface{}{ &RdsDbInstanceProperty{ DbPassword: jsii.String("dbPassword"), DbUser: jsii.String("dbUser"), RdsDbInstanceArn: jsii.String("rdsDbInstanceArn"), }, }, SourceStackId: jsii.String("sourceStackId"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, UseCustomCookbooks: jsii.Boolean(false), UseOpsworksSecurityGroups: jsii.Boolean(false), VpcId: jsii.String("vpcId"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html
func NewCfnStack ¶
func NewCfnStack(scope constructs.Construct, id *string, props *CfnStackProps) CfnStack
type CfnStackProps ¶
type CfnStackProps struct { // The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. // // For more information about IAM ARNs, see [Using Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultinstanceprofilearn // DefaultInstanceProfileArn *string `field:"required" json:"defaultInstanceProfileArn" yaml:"defaultInstanceProfileArn"` // The stack name. // // Stack names can be a maximum of 64 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-name // Name *string `field:"required" json:"name" yaml:"name"` // The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. // // You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see [Using Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-servicerolearn // ServiceRoleArn *string `field:"required" json:"serviceRoleArn" yaml:"serviceRoleArn"` // The default AWS OpsWorks Stacks agent version. You have the following options:. // // - Auto-update - Set this parameter to `LATEST` . AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. // - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks installs that version on the stack's instances. // // The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call `DescribeAgentVersions` . AgentVersion cannot be set to Chef 12.2. // // > You can also specify an agent version when you create or update an instance, which overrides the stack's default setting. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-agentversion // AgentVersion *string `field:"optional" json:"agentVersion" yaml:"agentVersion"` // One or more user-defined key-value pairs to be added to the stack attributes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-attributes // Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"` // A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see [Create a New Stack](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-chefconfiguration // ChefConfiguration interface{} `field:"optional" json:"chefConfiguration" yaml:"chefConfiguration"` // If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-cloneappids // CloneAppIds *[]*string `field:"optional" json:"cloneAppIds" yaml:"cloneAppIds"` // If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-clonepermissions // ClonePermissions interface{} `field:"optional" json:"clonePermissions" yaml:"clonePermissions"` // The configuration manager. // // When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-configurationmanager // ConfigurationManager interface{} `field:"optional" json:"configurationManager" yaml:"configurationManager"` // Contains the information required to retrieve an app or cookbook from a repository. // // For more information, see [Adding Apps](https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) or [Cookbooks and Recipes](https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-customcookbookssource // CustomCookbooksSource interface{} `field:"optional" json:"customCookbooksSource" yaml:"customCookbooksSource"` // A string that contains user-defined, custom JSON. // // It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format: // // `"{\"key1\": \"value1\", \"key2\": \"value2\",...}"` // // For more information about custom JSON, see [Use Custom JSON to Modify the Stack Configuration Attributes](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-customjson // CustomJson interface{} `field:"optional" json:"customJson" yaml:"customJson"` // The stack's default Availability Zone, which must be in the specified region. // // For more information, see [Regions and Endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html) . If you also specify a value for `DefaultSubnetId` , the subnet must be in the same zone. For more information, see the `VpcId` parameter description. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultavailabilityzone // DefaultAvailabilityZone *string `field:"optional" json:"defaultAvailabilityZone" yaml:"defaultAvailabilityZone"` // The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. // // You can specify one of the following. // // - A supported Linux operating system: An Amazon Linux version, such as `Amazon Linux 2` , `Amazon Linux 2018.03` , `Amazon Linux 2017.09` , `Amazon Linux 2017.03` , `Amazon Linux 2016.09` , `Amazon Linux 2016.03` , `Amazon Linux 2015.09` , or `Amazon Linux 2015.03` . // - A supported Ubuntu operating system, such as `Ubuntu 18.04 LTS` , `Ubuntu 16.04 LTS` , `Ubuntu 14.04 LTS` , or `Ubuntu 12.04 LTS` . // - `CentOS Linux 7` // - `Red Hat Enterprise Linux 7` // - A supported Windows operating system, such as `Microsoft Windows Server 2012 R2 Base` , `Microsoft Windows Server 2012 R2 with SQL Server Express` , `Microsoft Windows Server 2012 R2 with SQL Server Standard` , or `Microsoft Windows Server 2012 R2 with SQL Server Web` . // - A custom AMI: `Custom` . You specify the custom AMI you want to use when you create instances. For more information, see [Using Custom AMIs](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html) . // // The default option is the current Amazon Linux version. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see [AWS OpsWorks Stacks Operating Systems](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultos // DefaultOs *string `field:"optional" json:"defaultOs" yaml:"defaultOs"` // The default root device type. // // This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is `instance-store` . For more information, see [Storage for the Root Device](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultrootdevicetype // DefaultRootDeviceType *string `field:"optional" json:"defaultRootDeviceType" yaml:"defaultRootDeviceType"` // A default Amazon EC2 key pair name. // // The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see [Using SSH to Communicate with an Instance](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) and [Managing SSH Access](https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html) . You can override this setting by specifying a different key pair, or no key pair, when you [create an instance](https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultsshkeyname // DefaultSshKeyName *string `field:"optional" json:"defaultSshKeyName" yaml:"defaultSshKeyName"` // The stack's default subnet ID. // // All instances are launched into this subnet unless you specify another subnet ID when you create the instance. This parameter is required if you specify a value for the `VpcId` parameter. If you also specify a value for `DefaultAvailabilityZone` , the subnet must be in that zone. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultsubnetid // DefaultSubnetId *string `field:"optional" json:"defaultSubnetId" yaml:"defaultSubnetId"` // The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack. // // > If you specify a cluster that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-ecsclusterarn // EcsClusterArn *string `field:"optional" json:"ecsClusterArn" yaml:"ecsClusterArn"` // A list of Elastic IP addresses to register with the AWS OpsWorks stack. // // > If you specify an IP address that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-elasticips // ElasticIps interface{} `field:"optional" json:"elasticIps" yaml:"elasticIps"` // The stack's host name theme, with spaces replaced by underscores. // // The theme is used to generate host names for the stack's instances. By default, `HostnameTheme` is set to `Layer_Dependent` , which creates host names by appending integers to the layer's short name. The other themes are: // // - `Baked_Goods` // - `Clouds` // - `Europe_Cities` // - `Fruits` // - `Greek_Deities_and_Titans` // - `Legendary_creatures_from_Japan` // - `Planets_and_Moons` // - `Roman_Deities` // - `Scottish_Islands` // - `US_Cities` // - `Wild_Cats` // // To obtain a generated host name, call `GetHostNameSuggestion` , which returns a host name based on the current theme. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-hostnametheme // HostnameTheme *string `field:"optional" json:"hostnameTheme" yaml:"hostnameTheme"` // The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack. // // > If you specify a database instance that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the database instance. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-rdsdbinstances // RdsDbInstances interface{} `field:"optional" json:"rdsDbInstances" yaml:"rdsDbInstances"` // If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-sourcestackid // SourceStackId *string `field:"optional" json:"sourceStackId" yaml:"sourceStackId"` // A map that contains tag keys and tag values that are attached to a stack or layer. // // - The key cannot be empty. // - The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: `+ - = . _ : /` // - The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: `+ - = . _ : /` // - Leading and trailing white spaces are trimmed from both the key and value. // - A maximum of 40 tags is allowed for any resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Whether the stack uses custom cookbooks. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-usecustomcookbooks // UseCustomCookbooks interface{} `field:"optional" json:"useCustomCookbooks" yaml:"useCustomCookbooks"` // Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. // // AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With `UseOpsworksSecurityGroups` you can instead provide your own custom security groups. `UseOpsworksSecurityGroups` has the following settings: // // - True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group. // - False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings. // // For more information, see [Create a New Stack](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-useopsworkssecuritygroups // UseOpsworksSecurityGroups interface{} `field:"optional" json:"useOpsworksSecurityGroups" yaml:"useOpsworksSecurityGroups"` // The ID of the VPC that the stack is to be launched into. // // The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later. // // - If your account supports EC2-Classic, the default value is `no VPC` . // - If your account does not support EC2-Classic, the default value is the default VPC for the specified region. // // If the VPC ID corresponds to a default VPC and you have specified either the `DefaultAvailabilityZone` or the `DefaultSubnetId` parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively. // // If you specify a nondefault VPC ID, note the following: // // - It must belong to a VPC in your account that is in the specified region. // - You must specify a value for `DefaultSubnetId` . // // For more information about how to use AWS OpsWorks Stacks with a VPC, see [Running a Stack in a VPC](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html) . For more information about default VPC and EC2-Classic, see [Supported Platforms](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-vpcid // VpcId *string `field:"optional" json:"vpcId" yaml:"vpcId"` }
Properties for defining a `CfnStack`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customJson interface{} cfnStackProps := &CfnStackProps{ DefaultInstanceProfileArn: jsii.String("defaultInstanceProfileArn"), Name: jsii.String("name"), ServiceRoleArn: jsii.String("serviceRoleArn"), // the properties below are optional AgentVersion: jsii.String("agentVersion"), Attributes: map[string]*string{ "attributesKey": jsii.String("attributes"), }, ChefConfiguration: &ChefConfigurationProperty{ BerkshelfVersion: jsii.String("berkshelfVersion"), ManageBerkshelf: jsii.Boolean(false), }, CloneAppIds: []*string{ jsii.String("cloneAppIds"), }, ClonePermissions: jsii.Boolean(false), ConfigurationManager: &StackConfigurationManagerProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, CustomCookbooksSource: &SourceProperty{ Password: jsii.String("password"), Revision: jsii.String("revision"), SshKey: jsii.String("sshKey"), Type: jsii.String("type"), Url: jsii.String("url"), Username: jsii.String("username"), }, CustomJson: customJson, DefaultAvailabilityZone: jsii.String("defaultAvailabilityZone"), DefaultOs: jsii.String("defaultOs"), DefaultRootDeviceType: jsii.String("defaultRootDeviceType"), DefaultSshKeyName: jsii.String("defaultSshKeyName"), DefaultSubnetId: jsii.String("defaultSubnetId"), EcsClusterArn: jsii.String("ecsClusterArn"), ElasticIps: []interface{}{ &ElasticIpProperty{ Ip: jsii.String("ip"), // the properties below are optional Name: jsii.String("name"), }, }, HostnameTheme: jsii.String("hostnameTheme"), RdsDbInstances: []interface{}{ &RdsDbInstanceProperty{ DbPassword: jsii.String("dbPassword"), DbUser: jsii.String("dbUser"), RdsDbInstanceArn: jsii.String("rdsDbInstanceArn"), }, }, SourceStackId: jsii.String("sourceStackId"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, UseCustomCookbooks: jsii.Boolean(false), UseOpsworksSecurityGroups: jsii.Boolean(false), VpcId: jsii.String("vpcId"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html
type CfnStack_ChefConfigurationProperty ¶
type CfnStack_ChefConfigurationProperty struct { // The Berkshelf version. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-stack-chefconfiguration-berkshelfversion // BerkshelfVersion *string `field:"optional" json:"berkshelfVersion" yaml:"berkshelfVersion"` // Whether to enable Berkshelf. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-chefconfiguration.html#cfn-opsworks-stack-chefconfiguration-manageberkshelf // ManageBerkshelf interface{} `field:"optional" json:"manageBerkshelf" yaml:"manageBerkshelf"` }
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" chefConfigurationProperty := &ChefConfigurationProperty{ BerkshelfVersion: jsii.String("berkshelfVersion"), ManageBerkshelf: jsii.Boolean(false), }
type CfnStack_ElasticIpProperty ¶
type CfnStack_ElasticIpProperty struct { // The IP address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-ip // Ip *string `field:"required" json:"ip" yaml:"ip"` // The name, which can be a maximum of 32 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-elasticip.html#cfn-opsworks-stack-elasticip-name // Name *string `field:"optional" json:"name" yaml:"name"` }
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" elasticIpProperty := &ElasticIpProperty{ Ip: jsii.String("ip"), // the properties below are optional Name: jsii.String("name"), }
type CfnStack_RdsDbInstanceProperty ¶
type CfnStack_RdsDbInstanceProperty struct { // AWS OpsWorks Stacks returns `*****FILTERED*****` instead of the actual value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbpassword // DbPassword *string `field:"required" json:"dbPassword" yaml:"dbPassword"` // The master user name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbuser // DbUser *string `field:"required" json:"dbUser" yaml:"dbUser"` // The instance's ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-rdsdbinstancearn // RdsDbInstanceArn *string `field:"required" json:"rdsDbInstanceArn" yaml:"rdsDbInstanceArn"` }
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" rdsDbInstanceProperty := &RdsDbInstanceProperty{ DbPassword: jsii.String("dbPassword"), DbUser: jsii.String("dbUser"), RdsDbInstanceArn: jsii.String("rdsDbInstanceArn"), }
type CfnStack_SourceProperty ¶
type CfnStack_SourceProperty struct { // When included in a request, the parameter depends on the repository type. // // - For Amazon S3 bundles, set `Password` to the appropriate IAM secret access key. // - For HTTP bundles and Subversion repositories, set `Password` to the password. // // For more information on how to safely handle IAM credentials, see [](https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html) . // // In responses, AWS OpsWorks Stacks returns `*****FILTERED*****` instead of the actual value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-stack-source-password // Password *string `field:"optional" json:"password" yaml:"password"` // The application's version. // // AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-stack-source-revision // Revision *string `field:"optional" json:"revision" yaml:"revision"` // The repository's SSH key. // // For more information, see [Using Git Repository SSH Keys](https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploykeys.html) in the *AWS OpsWorks User Guide* . To pass in an SSH key as a parameter, see the following example: // // `"Parameters" : { "GitSSHKey" : { "Description" : "Change SSH key newlines to commas.", "Type" : "CommaDelimitedList", "NoEcho" : "true" }, ... "CustomCookbooksSource": { "Revision" : { "Ref": "GitRevision"}, "SshKey" : { "Fn::Join" : [ "\n", { "Ref": "GitSSHKey"} ] }, "Type": "git", "Url": { "Ref": "GitURL"} } ...` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-stack-source-sshkey // SshKey *string `field:"optional" json:"sshKey" yaml:"sshKey"` // The repository type. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-stack-source-type // Type *string `field:"optional" json:"type" yaml:"type"` // The source URL. // // The following is an example of an Amazon S3 source URL: `https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-stack-source-url // Url *string `field:"optional" json:"url" yaml:"url"` // This parameter depends on the repository type. // // - For Amazon S3 bundles, set `Username` to the appropriate IAM access key ID. // - For HTTP bundles, Git repositories, and Subversion repositories, set `Username` to the user name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-stack-source-username // Username *string `field:"optional" json:"username" yaml:"username"` }
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" sourceProperty := &SourceProperty{ Password: jsii.String("password"), Revision: jsii.String("revision"), SshKey: jsii.String("sshKey"), Type: jsii.String("type"), Url: jsii.String("url"), Username: jsii.String("username"), }
type CfnStack_StackConfigurationManagerProperty ¶
type CfnStack_StackConfigurationManagerProperty struct { // The name. // // This parameter must be set to `Chef` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigurationmanager.html#cfn-opsworks-stack-stackconfigurationmanager-name // Name *string `field:"optional" json:"name" yaml:"name"` // The Chef version. // // This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-stackconfigurationmanager.html#cfn-opsworks-stack-stackconfigurationmanager-version // Version *string `field:"optional" json:"version" yaml:"version"` }
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" stackConfigurationManagerProperty := &StackConfigurationManagerProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }
type CfnUserProfile ¶
type CfnUserProfile interface { awscdk.CfnResource awscdk.IInspectable // Whether users can specify their own SSH public key through the My Settings page. AllowSelfManagement() interface{} SetAllowSelfManagement(val interface{}) AttrId() *string // The user's SSH user name, as a string. AttrSshUsername() *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 user's IAM ARN. IamUserArn() *string SetIamUserArn(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 user's SSH public key. SshPublicKey() *string SetSshPublicKey(val *string) // The user's SSH user name. SshUsername() *string SetSshUsername(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{}) }
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnUserProfile := awscdk.Aws_opsworks.NewCfnUserProfile(this, jsii.String("MyCfnUserProfile"), &CfnUserProfileProps{ IamUserArn: jsii.String("iamUserArn"), // the properties below are optional AllowSelfManagement: jsii.Boolean(false), SshPublicKey: jsii.String("sshPublicKey"), SshUsername: jsii.String("sshUsername"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html
func NewCfnUserProfile ¶
func NewCfnUserProfile(scope constructs.Construct, id *string, props *CfnUserProfileProps) CfnUserProfile
type CfnUserProfileProps ¶
type CfnUserProfileProps struct { // The user's IAM ARN. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-iamuserarn // IamUserArn *string `field:"required" json:"iamUserArn" yaml:"iamUserArn"` // Whether users can specify their own SSH public key through the My Settings page. // // For more information, see [Managing User Permissions](https://docs.aws.amazon.com/opsworks/latest/userguide/security-settingsshkey.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-allowselfmanagement // AllowSelfManagement interface{} `field:"optional" json:"allowSelfManagement" yaml:"allowSelfManagement"` // The user's SSH public key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshpublickey // SshPublicKey *string `field:"optional" json:"sshPublicKey" yaml:"sshPublicKey"` // The user's SSH user name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html#cfn-opsworks-userprofile-sshusername // SshUsername *string `field:"optional" json:"sshUsername" yaml:"sshUsername"` }
Properties for defining a `CfnUserProfile`.
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" cfnUserProfileProps := &CfnUserProfileProps{ IamUserArn: jsii.String("iamUserArn"), // the properties below are optional AllowSelfManagement: jsii.Boolean(false), SshPublicKey: jsii.String("sshPublicKey"), SshUsername: jsii.String("sshUsername"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-userprofile.html
type CfnVolume ¶
type CfnVolume interface { awscdk.CfnResource awscdk.IInspectable AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The Amazon EC2 volume ID. Ec2VolumeId() *string SetEc2VolumeId(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 volume mount point. MountPoint() *string SetMountPoint(val *string) // The volume name. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The stack ID. StackId() *string SetStackId(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{}) }
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnVolume := awscdk.Aws_opsworks.NewCfnVolume(this, jsii.String("MyCfnVolume"), &CfnVolumeProps{ Ec2VolumeId: jsii.String("ec2VolumeId"), StackId: jsii.String("stackId"), // the properties below are optional MountPoint: jsii.String("mountPoint"), Name: jsii.String("name"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html
func NewCfnVolume ¶
func NewCfnVolume(scope constructs.Construct, id *string, props *CfnVolumeProps) CfnVolume
type CfnVolumeProps ¶
type CfnVolumeProps struct { // The Amazon EC2 volume ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-ec2volumeid // Ec2VolumeId *string `field:"required" json:"ec2VolumeId" yaml:"ec2VolumeId"` // The stack ID. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-stackid // StackId *string `field:"required" json:"stackId" yaml:"stackId"` // The volume mount point. // // For example, "/mnt/disk1". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-mountpoint // MountPoint *string `field:"optional" json:"mountPoint" yaml:"mountPoint"` // The volume name. // // Volume names are a maximum of 128 characters. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html#cfn-opsworks-volume-name // Name *string `field:"optional" json:"name" yaml:"name"` }
Properties for defining a `CfnVolume`.
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" cfnVolumeProps := &CfnVolumeProps{ Ec2VolumeId: jsii.String("ec2VolumeId"), StackId: jsii.String("stackId"), // the properties below are optional MountPoint: jsii.String("mountPoint"), Name: jsii.String("name"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html
Source Files ¶
- CfnApp.go
- CfnAppProps.go
- CfnApp_DataSourceProperty.go
- CfnApp_EnvironmentVariableProperty.go
- CfnApp_SourceProperty.go
- CfnApp_SslConfigurationProperty.go
- CfnApp__checks.go
- CfnElasticLoadBalancerAttachment.go
- CfnElasticLoadBalancerAttachmentProps.go
- CfnElasticLoadBalancerAttachment__checks.go
- CfnInstance.go
- CfnInstanceProps.go
- CfnInstance_BlockDeviceMappingProperty.go
- CfnInstance_EbsBlockDeviceProperty.go
- CfnInstance_TimeBasedAutoScalingProperty.go
- CfnInstance__checks.go
- CfnLayer.go
- CfnLayerProps.go
- CfnLayer_AutoScalingThresholdsProperty.go
- CfnLayer_LifecycleEventConfigurationProperty.go
- CfnLayer_LoadBasedAutoScalingProperty.go
- CfnLayer_RecipesProperty.go
- CfnLayer_ShutdownEventConfigurationProperty.go
- CfnLayer_VolumeConfigurationProperty.go
- CfnLayer__checks.go
- CfnStack.go
- CfnStackProps.go
- CfnStack_ChefConfigurationProperty.go
- CfnStack_ElasticIpProperty.go
- CfnStack_RdsDbInstanceProperty.go
- CfnStack_SourceProperty.go
- CfnStack_StackConfigurationManagerProperty.go
- CfnStack__checks.go
- CfnUserProfile.go
- CfnUserProfileProps.go
- CfnUserProfile__checks.go
- CfnVolume.go
- CfnVolumeProps.go
- CfnVolume__checks.go
- main.go