Documentation
¶
Index ¶
- func CfnEnvironmentEC2_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEnvironmentEC2_IsCfnElement(x interface{}) *bool
- func CfnEnvironmentEC2_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnEnvironmentEC2_IsConstruct(x interface{}) *bool
- func Ec2Environment_IsConstruct(x interface{}) *bool
- func Ec2Environment_IsResource(construct awscdk.IConstruct) *bool
- func NewCfnEnvironmentEC2_Override(c CfnEnvironmentEC2, scope awscdk.Construct, id *string, ...)
- func NewEc2Environment_Override(e Ec2Environment, scope constructs.Construct, id *string, ...)
- type CfnEnvironmentEC2
- type CfnEnvironmentEC2Props
- type CfnEnvironmentEC2_RepositoryProperty
- type CloneRepository
- type Ec2Environment
- type Ec2EnvironmentProps
- type IEc2Environment
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnEnvironmentEC2_CFN_RESOURCE_TYPE_NAME ¶
func CfnEnvironmentEC2_CFN_RESOURCE_TYPE_NAME() *string
func CfnEnvironmentEC2_IsCfnElement ¶
func CfnEnvironmentEC2_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. Experimental.
func CfnEnvironmentEC2_IsCfnResource ¶
func CfnEnvironmentEC2_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnEnvironmentEC2_IsConstruct ¶
func CfnEnvironmentEC2_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func Ec2Environment_IsConstruct ¶
func Ec2Environment_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func Ec2Environment_IsResource ¶
func Ec2Environment_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func NewCfnEnvironmentEC2_Override ¶
func NewCfnEnvironmentEC2_Override(c CfnEnvironmentEC2, scope awscdk.Construct, id *string, props *CfnEnvironmentEC2Props)
Create a new `AWS::Cloud9::EnvironmentEC2`.
func NewEc2Environment_Override ¶
func NewEc2Environment_Override(e Ec2Environment, scope constructs.Construct, id *string, props *Ec2EnvironmentProps)
Experimental.
Types ¶
type CfnEnvironmentEC2 ¶
type CfnEnvironmentEC2 interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrName() *string
AutomaticStopTimeMinutes() *float64
SetAutomaticStopTimeMinutes(val *float64)
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
ConnectionType() *string
SetConnectionType(val *string)
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
ImageId() *string
SetImageId(val *string)
InstanceType() *string
SetInstanceType(val *string)
LogicalId() *string
Name() *string
SetName(val *string)
Node() awscdk.ConstructNode
OwnerArn() *string
SetOwnerArn(val *string)
Ref() *string
Repositories() interface{}
SetRepositories(val interface{})
Stack() awscdk.Stack
SubnetId() *string
SetSubnetId(val *string)
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::Cloud9::EnvironmentEC2`.
The `AWS::Cloud9::EnvironmentEC2` resource creates an Amazon EC2 development environment in AWS Cloud9 . For more information, see [Creating an Environment](https://docs.aws.amazon.com/cloud9/latest/user-guide/create-environment.html) in the *AWS Cloud9 User Guide* .
TODO: EXAMPLE
func NewCfnEnvironmentEC2 ¶
func NewCfnEnvironmentEC2(scope awscdk.Construct, id *string, props *CfnEnvironmentEC2Props) CfnEnvironmentEC2
Create a new `AWS::Cloud9::EnvironmentEC2`.
type CfnEnvironmentEC2Props ¶
type CfnEnvironmentEC2Props struct {
// The type of instance to connect to the environment (for example, `t2.micro` ).
InstanceType *string `json:"instanceType" yaml:"instanceType"`
// The number of minutes until the running instance is shut down after the environment was last used.
AutomaticStopTimeMinutes *float64 `json:"automaticStopTimeMinutes" yaml:"automaticStopTimeMinutes"`
// The connection type used for connecting to an Amazon EC2 environment.
//
// Valid values are `CONNECT_SSH` (default) and `CONNECT_SSM` (connected through AWS Systems Manager ).
ConnectionType *string `json:"connectionType" yaml:"connectionType"`
// The description of the environment to create.
Description *string `json:"description" yaml:"description"`
// The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance.
//
// To choose an AMI for the instance, you must specify a valid AMI alias or a valid AWS Systems Manager path.
//
// The default AMI is used if the parameter isn't explicitly assigned a value in the request.
//
// *AMI aliases*
//
// - *Amazon Linux (default): `amazonlinux-1-x86_64`*
// - Amazon Linux 2: `amazonlinux-2-x86_64`
// - Ubuntu 18.04: `ubuntu-18.04-x86_64`
//
// *SSM paths*
//
// - *Amazon Linux (default): `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-1-x86_64`*
// - Amazon Linux 2: `resolve:ssm:/aws/service/cloud9/amis/amazonlinux-2-x86_64`
// - Ubuntu 18.04: `resolve:ssm:/aws/service/cloud9/amis/ubuntu-18.04-x86_64`
ImageId *string `json:"imageId" yaml:"imageId"`
// The name of the environment.
Name *string `json:"name" yaml:"name"`
// The Amazon Resource Name (ARN) of the environment owner.
//
// This ARN can be the ARN of any AWS Identity and Access Management principal. If this value is not specified, the ARN defaults to this environment's creator.
OwnerArn *string `json:"ownerArn" yaml:"ownerArn"`
// Any AWS CodeCommit source code repositories to be cloned into the development environment.
Repositories interface{} `json:"repositories" yaml:"repositories"`
// The ID of the subnet in Amazon Virtual Private Cloud (Amazon VPC) that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud (Amazon EC2) instance.
SubnetId *string `json:"subnetId" yaml:"subnetId"`
// An array of key-value pairs that will be associated with the new AWS Cloud9 development environment.
Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnEnvironmentEC2`.
TODO: EXAMPLE
type CfnEnvironmentEC2_RepositoryProperty ¶
type CfnEnvironmentEC2_RepositoryProperty struct {
// The path within the development environment's default file system location to clone the AWS CodeCommit repository into.
//
// For example, `/REPOSITORY_NAME` would clone the repository into the `/home/USER_NAME/environment/REPOSITORY_NAME` directory in the environment.
PathComponent *string `json:"pathComponent" yaml:"pathComponent"`
// The clone URL of the AWS CodeCommit repository to be cloned.
//
// For example, for an AWS CodeCommit repository this might be `https://git-codecommit.us-east-2.amazonaws.com/v1/repos/REPOSITORY_NAME` .
RepositoryUrl *string `json:"repositoryUrl" yaml:"repositoryUrl"`
}
The `Repository` property type specifies an AWS CodeCommit source code repository to be cloned into an AWS Cloud9 development environment.
TODO: EXAMPLE
type CloneRepository ¶
The class for different repository providers.
TODO: EXAMPLE
Experimental.
func CloneRepository_FromCodeCommit ¶
func CloneRepository_FromCodeCommit(repository awscodecommit.IRepository, path *string) CloneRepository
import repository to cloud9 environment from AWS CodeCommit. Experimental.
type Ec2Environment ¶
type Ec2Environment interface {
awscdk.Resource
IEc2Environment
Ec2EnvironmentArn() *string
Ec2EnvironmentName() *string
Env() *awscdk.ResourceEnvironment
EnvironmentId() *string
IdeUrl() *string
Node() awscdk.ConstructNode
PhysicalName() *string
Stack() awscdk.Stack
Vpc() awsec2.IVpc
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
GetResourceNameAttribute(nameAttr *string) *string
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
Prepare()
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
}
A Cloud9 Environment with Amazon EC2.
TODO: EXAMPLE
Experimental.
func NewEc2Environment ¶
func NewEc2Environment(scope constructs.Construct, id *string, props *Ec2EnvironmentProps) Ec2Environment
Experimental.
type Ec2EnvironmentProps ¶
type Ec2EnvironmentProps struct {
// The VPC that AWS Cloud9 will use to communicate with the Amazon Elastic Compute Cloud (Amazon EC2) instance.
// Experimental.
Vpc awsec2.IVpc `json:"vpc" yaml:"vpc"`
// The AWS CodeCommit repository to be cloned.
// Experimental.
ClonedRepositories *[]CloneRepository `json:"clonedRepositories" yaml:"clonedRepositories"`
// Description of the environment.
// Experimental.
Description *string `json:"description" yaml:"description"`
// Name of the environment.
// Experimental.
Ec2EnvironmentName *string `json:"ec2EnvironmentName" yaml:"ec2EnvironmentName"`
// The type of instance to connect to the environment.
// Experimental.
InstanceType awsec2.InstanceType `json:"instanceType" yaml:"instanceType"`
// The subnetSelection of the VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.
// Experimental.
SubnetSelection *awsec2.SubnetSelection `json:"subnetSelection" yaml:"subnetSelection"`
}
Properties for Ec2Environment.
TODO: EXAMPLE
Experimental.
type IEc2Environment ¶
type IEc2Environment interface {
awscdk.IResource
// The arn of the EnvironmentEc2.
// Experimental.
Ec2EnvironmentArn() *string
// The name of the EnvironmentEc2.
// Experimental.
Ec2EnvironmentName() *string
}
A Cloud9 Environment. Experimental.
func Ec2Environment_FromEc2EnvironmentName ¶
func Ec2Environment_FromEc2EnvironmentName(scope constructs.Construct, id *string, ec2EnvironmentName *string) IEc2Environment
import from EnvironmentEc2Name. Experimental.