Show / Hide Table of Contents

Class Ocean

Inheritance
System.Object
Resource
CustomResource
Ocean
Inherited Members
CustomResource.Id
Resource.GetResourceType()
Resource.GetResourceName()
Resource.Urn
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.SpotInst.Ecs
Assembly: Pulumi.SpotInst.dll
Syntax
public class Ocean : CustomResource

Constructors

View Source

Ocean(String, OceanArgs, CustomResourceOptions)

Create a Ocean resource with the given unique name, arguments, and options.

Declaration
public Ocean(string name, OceanArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource

OceanArgs args

The arguments used to populate this resource's properties

CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AssociatePublicIpAddress

Configure public IP address allocation.

Declaration
public Output<bool?> AssociatePublicIpAddress { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Autoscaler

Declaration
public Output<OceanAutoscaler> Autoscaler { get; }
Property Value
Type Description
Output<OceanAutoscaler>
View Source

ClusterName

The ocean cluster name.

Declaration
public Output<string> ClusterName { get; }
Property Value
Type Description
Output<System.String>
View Source

DesiredCapacity

The number of instances to launch and maintain in the cluster.

Declaration
public Output<int> DesiredCapacity { get; }
Property Value
Type Description
Output<System.Int32>
View Source

DrainingTimeout

The time in seconds, the instance is allowed to run while detached from the ELB. This is to allow the instance time to be drained from incoming TCP connections before terminating it, during a scale down operation.

Declaration
public Output<int?> DrainingTimeout { get; }
Property Value
Type Description
Output<System.Nullable<System.Int32>>
View Source

EbsOptimized

Enable EBS optimized for cluster. Flag will enable optimized capacity for high bandwidth connectivity to the EB service for non EBS optimized instance types. For instances that are EBS optimized this flag will be ignored.

Declaration
public Output<bool?> EbsOptimized { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

IamInstanceProfile

The instance profile iam role.

Declaration
public Output<string> IamInstanceProfile { get; }
Property Value
Type Description
Output<System.String>
View Source

ImageId

ID of the image used to launch the instances.

Declaration
public Output<string> ImageId { get; }
Property Value
Type Description
Output<System.String>
View Source

KeyPair

The key pair to attach the instances.

Declaration
public Output<string> KeyPair { get; }
Property Value
Type Description
Output<System.String>
View Source

MaxSize

The upper limit of instances the cluster can scale up to.

Declaration
public Output<int> MaxSize { get; }
Property Value
Type Description
Output<System.Int32>
View Source

MinSize

The lower limit of instances the cluster can scale down to.

Declaration
public Output<int> MinSize { get; }
Property Value
Type Description
Output<System.Int32>
View Source

Monitoring

Enable detailed monitoring for cluster. Flag will enable Cloud Watch detailed detailed monitoring (one minute increments). Note: there are additional hourly costs for this service based on the region used.

Declaration
public Output<bool?> Monitoring { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Name

The Ocean cluster name.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

Region

The region the cluster will run in.

Declaration
public Output<string> Region { get; }
Property Value
Type Description
Output<System.String>
View Source

ScheduledTasks

Declaration
public Output<ImmutableArray<OceanScheduledTask>> ScheduledTasks { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<OceanScheduledTask>>
View Source

SecurityGroupIds

One or more security group ids.

Declaration
public Output<ImmutableArray<string>> SecurityGroupIds { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

SubnetIds

A comma-separated list of subnet identifiers for the Ocean cluster. Subnet IDs should be configured with auto assign public ip.

Declaration
public Output<ImmutableArray<string>> SubnetIds { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Tags

Optionally adds tags to instances launched in an Ocean cluster.

Declaration
public Output<ImmutableArray<OceanTag>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<OceanTag>>
View Source

UpdatePolicy

Declaration
public Output<OceanUpdatePolicy> UpdatePolicy { get; }
Property Value
Type Description
Output<OceanUpdatePolicy>
View Source

UserData

Base64-encoded MIME user data to make available to the instances.

Declaration
public Output<string> UserData { get; }
Property Value
Type Description
Output<System.String>
View Source

UtilizeReservedInstances

If Reserved instances exist, OCean will utilize them before launching Spot instances.

Declaration
public Output<bool?> UtilizeReservedInstances { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Whitelists

Instance types allowed in the Ocean cluster, Cannot be configured if blacklist is configured.

Declaration
public Output<ImmutableArray<string>> Whitelists { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Methods

View Source

Get(String, Input<String>, OceanState, CustomResourceOptions)

Get an existing Ocean resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Ocean Get(string name, Input<string> id, OceanState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.

Input<System.String> id

The unique provider ID of the resource to lookup.

OceanState state

Any extra arguments used during the lookup.

CustomResourceOptions options

A bag of options that control this resource's behavior

Returns
Type Description
Ocean
  • View Source
Back to top Copyright 2016-2020, Pulumi Corporation.