Skip to content

KeyPairs

This class encapsulates and extends the ROS resource type DATASOURCE::ECS::KeyPairs, which is used to query one or more key pairs.

Initializers 

from ros_cdk_ecs import datasource
datasource.KeyPairs(
  scope: Construct,
  id: str,
  key_pair_finger_print: typing.Union[str, IResolvable] = None,
  key_pair_name: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
key_pair_finger_print typing.Union[str, ros_cdk_core.IResolvable] Property keyPairFingerPrint: The fingerprint of the key pair.
key_pair_name typing.Union[str, ros_cdk_core.IResolvable] Property keyPairName: he name of the key pair.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: The ID of the resource group to which the key pair belongs.
tags typing.List[ros_cdk_ecs.datasource.RosKeyPairs.TagsProperty] Property tags: Tags of keypair.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

key_pair_finger_printOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property keyPairFingerPrint: The fingerprint of the key pair.

The message-digest algorithm 5 (MD5) is used based on the public key fingerprint format defined in RFC 4716. For more information, see RFC 4716.

key_pair_nameOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property keyPairName: he name of the key pair.

You can use the asterisk () symbol as a wildcard in regular expressions to query key pairs by performing a fuzzy search. Sample patterns: SshKey: queries key pairs whose names end with SshKey, including the key pair named SshKey. SshKey: queries key pairs whose names start with SshKey, including the key pair named SshKey. SshKey*: queries key pairs whose names include SshKey, including the key pair named SshKey. SshKey: queries the key pair named SshKey.

refresh_optionsOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

resource_group_idOptional

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group to which the key pair belongs.

If this parameter is specified to query resources, up to 1,000 resources that belong to the specified resource group can be displayed in the response.

tagsOptional

  • Type: typing.List[ros_cdk_ecs.datasource.RosKeyPairs.TagsProperty]

Property tags: Tags of keypair.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

from ros_cdk_ecs import datasource
datasource.KeyPairs.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_key_pair_names ros_cdk_core.IResolvable Attribute KeyPairNames: The list of key pair names.
attr_key_pairs ros_cdk_core.IResolvable Attribute KeyPairs: The list of key pairs.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_key_pair_namesRequired 

attr_key_pair_names: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute KeyPairNames: The list of key pair names.

attr_key_pairsRequired 

attr_key_pairs: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute KeyPairs: The list of key pairs.