awsemrcontainers

Documentation

Index

• func CfnVirtualCluster_CFN_RESOURCE_TYPE_NAME() *string
• func CfnVirtualCluster_IsCfnElement(x interface{}) *bool
• func CfnVirtualCluster_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnVirtualCluster_IsConstruct(x interface{}) *bool
• func NewCfnVirtualCluster_Override(c CfnVirtualCluster, scope constructs.Construct, id *string, ...)
• type CfnVirtualCluster
  • func NewCfnVirtualCluster(scope constructs.Construct, id *string, props *CfnVirtualClusterProps) CfnVirtualCluster
• type CfnVirtualClusterProps
• type CfnVirtualCluster_ContainerInfoProperty
• type CfnVirtualCluster_ContainerProviderProperty
• type CfnVirtualCluster_EksInfoProperty

Functions

func CfnVirtualCluster_CFN_RESOURCE_TYPE_NAME

func CfnVirtualCluster_CFN_RESOURCE_TYPE_NAME() *string

func CfnVirtualCluster_IsCfnElement

func CfnVirtualCluster_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 CfnVirtualCluster_IsCfnResource

func CfnVirtualCluster_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnVirtualCluster_IsConstruct

func CfnVirtualCluster_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

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

func NewCfnVirtualCluster_Override

func NewCfnVirtualCluster_Override(c CfnVirtualCluster, scope constructs.Construct, id *string, props *CfnVirtualClusterProps)

Create a new `AWS::EMRContainers::VirtualCluster`.

Types

type CfnVirtualCluster

type CfnVirtualCluster interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ContainerProvider() interface{}
	SetContainerProvider(val interface{})
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	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)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::EMRContainers::VirtualCluster`.

The `AWS::EMRContainers::VirtualCluster` resource specifies a virtual cluster. A virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list, and delete virtual clusters. They do not consume any additional resources in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

TODO: EXAMPLE

func NewCfnVirtualCluster

func NewCfnVirtualCluster(scope constructs.Construct, id *string, props *CfnVirtualClusterProps) CfnVirtualCluster

Create a new `AWS::EMRContainers::VirtualCluster`.

type CfnVirtualClusterProps

type CfnVirtualClusterProps struct {
	// The container provider of the virtual cluster.
	ContainerProvider interface{} `json:"containerProvider" yaml:"containerProvider"`
	// The name of the virtual cluster.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnVirtualCluster`.

TODO: EXAMPLE

type CfnVirtualCluster_ContainerInfoProperty

type CfnVirtualCluster_ContainerInfoProperty struct {
	// The information about the EKS cluster.
	EksInfo interface{} `json:"eksInfo" yaml:"eksInfo"`
}

The information about the container used for a job run or a managed endpoint.

TODO: EXAMPLE

type CfnVirtualCluster_ContainerProviderProperty

type CfnVirtualCluster_ContainerProviderProperty struct {
	// The ID of the container cluster.
	//
	// *Minimum* : 1
	//
	// *Maximum* : 100
	//
	// *Pattern* : `^[0-9A-Za-z][A-Za-z0-9\-_]*`
	Id *string `json:"id" yaml:"id"`
	// The information about the container cluster.
	Info interface{} `json:"info" yaml:"info"`
	// The type of the container provider.
	//
	// EKS is the only supported type as of now.
	Type *string `json:"type" yaml:"type"`
}

The information about the container provider.

TODO: EXAMPLE

type CfnVirtualCluster_EksInfoProperty

type CfnVirtualCluster_EksInfoProperty struct {
	// The namespaces of the EKS cluster.
	//
	// *Minimum* : 1
	//
	// *Maximum* : 63
	//
	// *Pattern* : `[a-z0-9]([-a-z0-9]*[a-z0-9])?`
	Namespace *string `json:"namespace" yaml:"namespace"`
}

The information about the EKS cluster.

TODO: EXAMPLE