on_premises_instances

Creates, updates, deletes, gets or lists an on_premises_instances resource.

Overview

Name	on_premises_instances
Type	Resource
Id	aws.codedeploy.on_premises_instances

Fields

The following fields are returned by SELECT queries:

batch_get_on_premises_instances

Name	Datatype	Description
instance_infos	array	Information about the on-premises instances.

get_on_premises_instance

Name	Datatype	Description
deregister_time	string (date-time)	If the on-premises instance was deregistered, the time at which the on-premises instance was deregistered.
iam_session_arn	string	The ARN of the IAM session associated with the on-premises instance.
iam_user_arn	string	The user ARN associated with the on-premises instance.
instance_arn	string	The ARN of the on-premises instance.
instance_name	string	The name of the on-premises instance.
register_time	string (date-time)	The time at which the on-premises instance was registered.
tags	array	The tags currently associated with the on-premises instance.

list_on_premises_instances

Name	Datatype	Description
instance_name	string	The list of matching on-premises instance names.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
batch_get_on_premises_instances	select	region		Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.
get_on_premises_instance	select	region		Gets information about an on-premises instance.
list_on_premises_instances	select	region		Gets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.
register_on_premises_instance	insert	region, instanceName		Registers an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.
deregister_on_premises_instance	delete	region		Deregisters an on-premises instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

batch_get_on_premises_instances

Gets information about one or more on-premises instances. The maximum number of on-premises instances that can be returned is 25.

SELECT
instance_infos
FROM aws.codedeploy.on_premises_instances
WHERE region = '{{ region }}' -- required
;

get_on_premises_instance

Gets information about an on-premises instance.

SELECT
deregister_time,
iam_session_arn,
iam_user_arn,
instance_arn,
instance_name,
register_time,
tags
FROM aws.codedeploy.on_premises_instances
WHERE region = '{{ region }}' -- required
;

list_on_premises_instances

Gets a list of names for one or more on-premises instances. Unless otherwise specified, both registered and deregistered on-premises instance names are listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.

SELECT
instance_name
FROM aws.codedeploy.on_premises_instances
WHERE region = '{{ region }}' -- required
;

INSERT examples

register_on_premises_instance

Registers an on-premises instance. Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.

INSERT INTO aws.codedeploy.on_premises_instances (
instanceName,
iamSessionArn,
iamUserArn,
region
)
SELECT 
'{{ instanceName }}' /* required */,
'{{ iamSessionArn }}',
'{{ iamUserArn }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: on_premises_instances
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the on_premises_instances resource.
  - name: instanceName
    value: "{{ instanceName }}"
    description: |
      The name of the on-premises instance to register.
  - name: iamSessionArn
    value: "{{ iamSessionArn }}"
    description: |
      The ARN of the IAM session to associate with the on-premises instance.
  - name: iamUserArn
    value: "{{ iamUserArn }}"
    description: |
      The ARN of the user to associate with the on-premises instance.

DELETE examples

deregister_on_premises_instance

Deregisters an on-premises instance.

DELETE FROM aws.codedeploy.on_premises_instances
WHERE region = '{{ region }}' --required
;